Update a contact
Change a contact's profile, custom properties, or subscription status.
/v1/emails/contacts/{contactId}Authorization
Bearer token
- Authorizationrequiredheader
Send your API key as
Bearer YOUR_API_KEY.
Path parameters
contactIdrequiredstringThe contact's ID, starting with
con_.
Body parameters
application/json
emailrequiredstringThe contact's email address. Send the current address to keep it.
userIdoptionalstring or nullYour identifier for this person.
nullclears it.firstNameoptionalstringFirst name. An empty string clears the value.
lastNameoptionalstringLast name. An empty string clears the value.
phoneNumberoptionalstringPhone number.
propertiesoptionalobjectReplaces the contact's custom property values. Properties you leave out are cleared; omit the field to keep them unchanged.
emailStatusoptionalstringUnsubscribing stops email to this address.
One of
"subscribed""unsubscribed"
Fields you omit, other than email, keep their current values.
Response
The updated contact is returned under data, in the same shape as Create a contact. Changing emailStatus to unsubscribed also sends a contact.unsubscribed webhook event.