API ReferenceContactsUpdate Contact Profile

Update Contact Profile

Update properties of an existing contact profile globally. Use syncMemberships to apply global status changes across all list memberships. Note that this endpoint is strictly for updates and will return a 404 Not Found error if the contact does not exist in the directory.

PATCHhttps://wapi.simplysend.email/web-setup/contacts/{identifier}

Parameters

identifierRequired

string

The contact's unique identifier. Must be a secure hashed channel identifier (e.g. 'email_<md5>' or 'phone_<md5>').

firstName

string

Updated first name.

lastName

string

Updated last name.

email^*

string

Updated email address.* Either email or phone must be provided.

phone^*

string

Updated phone number.* Either email or phone must be provided.

globalStatus

string

Updated global subscription status. Valid values: 'active', 'unsubscribed', 'bounced', 'complained'.

syncMemberships

boolean

Sync subscription memberships to match global status (e.g. deactivate all active list subscriptions if unsubscribed).

consentMethod

string

Updated consent method. Valid values: 'double_opt_in', 'single_opt_in', 'imported', 'web_form', 'implicit_api', 'other'.

consentDetails

string

Updated description of the consent flow or audit notes.

customFields

object

Updated key-value custom properties.

RequestPATCH

Response