Sign in
contacts

Update Contact Variables

Merge variables into a contact's and/or its account'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 is created so the account 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.

Account variables can also be managed directly through /v1/accounts/{account_id}/variables.

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.

account_variablesobject nullable

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

Response

Successful Response

contact_variablesobject required

Custom variables stored on the contact for this workspace.

account_variablesobject required

Custom variables stored on the contact's account for this workspace. Also manageable through the Account variables endpoints.

Changes

Changed in 1 of the 12 revisions of this API.112

  • 6e9ca9d5acac112See the full diff
    • ▲

      removed the required property company_variables from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property company_variables

      request-property-removed

    • ○

      added the new optional request property account_variables

      new-optional-request-property

    • ○

      added the required property account_variables to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog