PATCH/contacts/{id}

Update a contact

Updates a contact identified by its ID or email address. Include only the profile, subscription, or custom property fields you want to change.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
idstringrequired
The contact ID or email address.

Contact fields to update. Include only the fields you want to change.

emailstringoptional
Email address of the contact.
first_namestringoptional
First name of the contact.
last_namestringoptional
Last name of the contact.
unsubscribedbooleanoptional
The Contact's global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts.
propertiesobjectoptional
A map of custom property keys and values to update.

1 status code
200Returns the updated contact's identifier and the response object type.
objectstringoptional
Type of the response object.
idstringoptional
Unique identifier for the updated contact.

Error handling

The id path parameter must contain the contact's ID or email address. Custom property values must be strings, numbers, booleans, or null.