Skip to main content
POST
Deprecated. Custom fields are now called contact properties. This /custom-fields endpoint still works as an alias, but new integrations should use Create Contact Property. The new endpoint accepts name/type; the legacy fieldName/fieldType are still accepted.

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body Parameters

string
required
The programmatic name for the custom field. Must be unique within the project. Cannot be one of the reserved names: firstName, first_name, lastName, last_name, email, mobile, unsubscribed, unsubscribe, unsubscribe_groups, unsubscribe_preferences, userId, externalId, createdAt, updatedAt, contactLists, address, address_line_1, address_line_2, city, state, zip, country.
string
required
The data type of the custom field. Must be one of: string, number, boolean, date.
string
A human-readable description of what the field represents.
string
A fallback value used when a contact does not have an explicit value for this field.

Response

Custom field created successfully
boolean
Indicates whether the request was successful.
string
Confirmation message.Example: "Custom field created successfully"
object
The created custom field.