Skip to main content
PATCH
/
v1
/
contacts
/
{contact_id}
/
variables
Update Contact Variables
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contact_variables: {}, company_variables: {}})
};

fetch('https://api.topo.io/v1/contacts/{contact_id}/variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "contact_variables": {},
  "company_variables": {}
}

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

contact_id
string<uuid>
required

ID of the contact.

Body

application/json

Update Contact Variables payload

contact_variables
Contact Variables · object

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

company_variables
Company Variables · object

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

Response

200 - application/json

Successful Response

contact_variables
Contact Variables · object
required

Custom variables stored on the contact for this workspace.

company_variables
Company Variables · object
required

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