Skip to main content
PATCH
Update a contact
Partially update a contact. If no fields are provided the contact is returned unchanged. Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

contactId
string<uuid>
required

Contact ID

Body

application/json

Request to update a contact. All fields are optional.

email
string<email>

New email address (must remain unique within the team)

Maximum string length: 255
status
enum<string>
Available options:
subscribed,
unsubscribed
properties
object

Partial property update. A property set to null is removed.

Response

Updated

message
string
required
Example:

"Contact retrieved successfully."

data
object
required

Audience contact