Skip to main content
POST

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 contact property. 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.The legacy fieldName parameter is still accepted as an alias for name.
string
required
The data type of the contact property. Must be one of: string, number, boolean, date.The legacy fieldType parameter is still accepted as an alias for type.
string
A human-readable description of what the property represents.
string
A fallback value used when a contact does not have an explicit value for this property.

Response

Contact property created successfully
boolean
Indicates whether the request was successful.
string
Confirmation message.Example: "Contact property created successfully"
object
The created contact property.