Create contact
Create a new contact with an email address and any other contact properties.
Request
Body
The contact’s email address.
The contact’s first name.
The contact’s last name.
A custom source value to replace the default “API”. Read more
Whether the contact will receive campaign and loops emails. Read more
You can use groups to segment users when sending emails. Currently, a contact can only be in one user group. Read more
A unique user ID (for example, from an external application). Read more
Key-value pairs of mailing list IDs and a boolean denoting if the contact
should be added (true) or removed (false) from the list. Read
more
{
"mailingLists": {
"list_123": true,
"list_456": false
}
}
Custom properties
You can also include custom contact properties in your request body. These should be added as top-level attributes in the request.
Custom properties can be of type string, number, boolean or date (see allowed date formats).
{
"email": "[email protected]",
"plan": "pro", /* Custom property */
"dateJoined": 1704711066 /* Custom property */
}
There are a few reserved names that you cannot use for custom properties.
To empty or reset the value of a contact property, send a null value.
Response
Success
The ID of the new contact.
Error
An error message.
Was this page helpful?