Contacts API - Custom Fields
Elements that can be shared among more than one endpoint definition.
Delete a Custom Field
Delete a Custom Field
DELETE /contactdb/custom_fields/{custom_field_id}
This endpoint allows you to delete a custom field by ID.
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Path Parameters
custom_field_id
integer
The ID of the custom field that you want to retrieve.
default: Nonerequired
Responses
object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.