contacts

Update Contact Variables

Changed on

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

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contacts/{contact_id}/variables
  • Auth: HTTP bearer

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

  • 6e9ca9d5acacRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status