PUT/api/v1/contacts/{id}

Replace contact attributes

Replaces the supplied attributes of a contact identified by its contact ID, email address, or external ID. Use id_type to specify which identifier you pass in id, and provide the contact attributes in the data object. Set status to active, unsubscribed, or unreachable when including a status value.

2 parameters · 1 body field
idstringrequired
The contact ID, email address, or external ID used to identify the contact.
id_typestringoptional
The type of identifier supplied in `id`: `id`, `email`, or `external_id`. Defaults to `id` when omitted.
Allowed:idemailexternal_id

Contact attributes to replace, provided in the data object.

dataobjectoptional
Object containing the contact attributes to replace.

1 status code
200Returns the updated contact object, including its ID, email, external ID, name, status, custom data, and creation and update timestamps.
dataobjectoptional

Error handling

The id path parameter supplies the contact identifier, and id_type must be id, email, or external_id if provided. The request body may omit data or any of its fields; if you provide status, it must be active, unsubscribed, or unreachable.