Contacts API - Custom Fields
Elements that can be shared among more than one endpoint definition.
Create a Custom Field
POST /v3/contactdb/custom_fields
Base url: https://api.sendgrid.com
This endpoint allows you to create a custom field.
You can create up to 120 custom fields.
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.
Request Body
object
name
string
type
string
{
"name": "pet",
"type": "text"
}Responses
object
name
string
The name of the field
type
string
The type of the field.
Allowed Values: date, text, numberid
number
The ID of the custom field.
{
"name": "first_name",
"type": "text"
}object
errors
array[object]
message
string
the error message
required
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. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
