Contacts
Keep a record of the people you email, with custom properties and subscription status.
Contacts are the people your project emails. Each contact has an email address, optional profile fields, custom properties, and an email subscription status. Deliveries to a known address are linked to its contact, so you can see a person's full email history.
Contact fields
emailrequiredstringUnique within your project.
userIdoptionalstringYour own identifier for the person, up to 255 characters.
firstNameoptionalstringFirst name, for personalization.
lastNameoptionalstringLast name, for personalization.
phoneNumberoptionalstringContact phone number.
propertiesoptionalobjectValues for the custom properties you have defined.
emailStatusstringNew contacts are subscribed.
One of
"subscribed""unsubscribed"
Custom properties
Define custom properties in the dashboard under Contacts → Custom fields — for example plan or signupSource — then set them with the properties object. Sending a property that is not defined returns 400, which keeps your data consistent.
Subscription status
A contact who unsubscribes is marked unsubscribed, and email to that address is suppressed. Your application can update the status with Update a contact, for example when a user changes their preferences in your app.
Keep contacts in sync
Contact allowances depend on your plan. Creating a contact beyond your allowance returns 429 with code contact_limit_exceeded.