v1

latestSwagger 2.0Apache 2.02026-08-06303655.6 KB

contacts

Update a contact

Updates editable fields on an existing contact. Only fields present in the request body are updated.

To link a contact to an external system, include system and identifier (and optionally system_identifier). If an external identifier already exists for the given system + system_identifier combination, it will be updated; otherwise a new one is created.

put/contacts/{id}

Path parameters

idstring required

Contact GUID

Request body

first_namestring

last_namestring

emailstring email

can_emailboolean

can_email_codestring

Machine-readable code indicating why can_email was changed

can_email_messagestring

Human-readable message describing why can_email was changed

optionsobject

Key-value attributes to merge into the contact's existing options. Input values take precedence; keys not in the request are preserved. Set a key to null to delete just that key. An empty object, null, or non-object value is a no-op — the stored options blob is never wholesale cleared.

systemstring

External system name (e.g. 'hubspot'). When provided with identifier, upserts an external identifier linking this contact to the external system.

identifierstring

The contact's unique ID in the external system. Required when system is provided.

system_identifierstring

Optional qualifier within the external system (e.g. a list ID or portal ID).

Response

Contact updated