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
The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
Request Body
{
"name": "pet",
"type": "text"
}Responses
The name of the field
The type of the field.
Allowed Values: date, text, numberThe ID of the custom field.
{
"name": "first_name",
"type": "text"
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"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.
