Create a contact
Add a person to your project, with optional profile fields and custom properties.
/v1/emails/contactsAuthorization
Bearer token
- Authorizationrequiredheader
Send your API key as
Bearer YOUR_API_KEY.
Body parameters
application/json
emailrequiredstringThe contact's email address. Must be unique in your project.
userIdoptionalstringYour own identifier for this person, up to 255 characters.
firstNameoptionalstringFirst name.
lastNameoptionalstringLast name.
phoneNumberoptionalstringPhone number.
propertiesoptionalobjectValues for custom properties you have defined. Keys are case-insensitive.
New contacts are subscribed.
Response
The contact is returned under data.
idstringContact identifier, starting with
con_.emailstringEmail address.
email_statusstringOne of
"subscribed""unsubscribed"sourcestringHow the contact was created, such as
manual.created_atstringISO 8601 timestamp.
A contact with the same email already exists in the project returns 409. An undefined property key returns 400. Reaching your plan's contact allowance returns 429 with code contact_limit_exceeded.