v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB

Contacts

Update Contact

Update a contact's details. Requires API key with audience:write.

patch/v1/contacts/{id}

idstring required

Contact ID (MongoDB ObjectId)

firstNamestring

lastNamestring

phonestring nullable

Phone number (free-form, max 30 chars). Null clears the field.

countrystring nullable

ISO 3166-1 alpha-2 country code

languagestring nullable

Language code (ISO 639-1 or BCP 47)

tagsstring[]

Tag names (tags will be auto-created if they don't exist)

customFieldsobject

Merged into the contact's existing custom fields — fields you don't include are left untouched. Pass an empty object to clear all custom fields.

status'subscribed' | 'unsubscribed' | 'bounced' | 'non-subscribed'

projectIdstring required

Contact updated

successboolean required

errorstring nullable