Menu

Custom Fields

Custom Fields allow you to add extra information about your contacts to your contact database. With custom fields, you can create custom segments from your individual contacts or from your contact database that will dynamically update your content with the values for the individual contact receiving the email. Your custom fields are completely customizable to the use cases and user information that you need.

You can also manage your Custom Fields using the Custom Fields UI in the Marketing Campaigns App. For more about creating Custom Fields, including a list of Reserved Fields, see our Custom Fields documentation.

Create Custom Field Definition

Create Custom Field Definition

POST /marketing/field_definitions

This endpoint creates a new custom field definition.

Custom field definitions are created with the given name and field_type. Although field names are stored in a case-sensitive manner, all field names must be case-insensitively unique. This means you may create a field named CamelCase or camelcase, but not both. Additionally, a Custom Field name cannot collide with any Reserved Field names. You should save the returned id value in order to update or delete the field at a later date. You can have up to 120 custom fields.

The custom field name should be created using only alphanumeric characters (A-Z and 0-9) and underscores (_). Custom fields can only begin with letters A-Z or underscores (_). The field type can be date, text, or number fields. The field type is important for creating segments from your contact database.

Note: Creating a custom field that begins with a number will cause issues with sending in Marketing Campaigns.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
name
string
maxLength: 100minLength: 1
required
field_type
string
Allowed Values: Text, Number, Date
required
{
  "name": "custom_field_name",
  "field_type": "Text"
}

Responses

object
id
string
required
name
string
maxLength: 100minLength: 1
required
field_type
string
Allowed Values: Text, Number, Date
required
_metadata
object
prev
string
format: uri
self
string
format: uri
next
string
format: uri
count
integer
minimum: 0
{
  "id": "a1_D",
  "name": "custom_field_name",
  "field_type": "Date"
}
object
errors
array[object]
uniqueItems: True
required
message
string
field
string
error_id
string
parameter
string
Rate this page:

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.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more