v3

OpenAPI 3.1.02026-07-2759128137.8 KB

contacts

Update Contact Variables

Merge variables into a contact's and/or its company's variables.

Upsert semantics: provided keys are written, other keys are kept. If the contact's company is not yet linked to your organization, the account link is created so the company variables can be stored.

Each scope holds at most 200 variables. A null value clears the variable but keeps the key counting toward the limit; use the DELETE endpoint to remove a key and free its slot.

Requires the contacts:write scope on the API key.

patch/v1/contacts/{contact_id}/variables

Path parameters

contact_idstring uuid required

ID of the contact.

Request body

contact_variablesobject nullable

Variables to merge into the contact's variables. Existing keys are overwritten.

company_variablesobject nullable

Variables to merge into the company's variables. Existing keys are overwritten.

Response

Successful Response

contact_variablesobject required

Custom variables stored on the contact for this workspace.

company_variablesobject required

Custom variables stored on the contact's company for this workspace.