Delete Contact Variable - Topo

DELETE

/

v1

/

contacts

/

{contact_id}

/

variables

/

{key}

Delete Contact Variable

curl --request DELETE \
  --url https://api.topo.io/v1/contacts/{contact_id}/variables/{key} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

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

import requests

url = "https://api.topo.io/v1/contacts/{contact_id}/variables/{key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "contact_variables": {},
  "account_variables": {}
}

Authorizations

Authorization

string

header

required

Bearer API key issued from Settings → Developers.

Path Parameters

contact_id

string<uuid>

required

ID of the contact.

key

string

required

ID of the key.

Query Parameters

scope

enum<string>

required

Whether to delete a contact or account variable.

Available options:

contact,

account

Response

200 - application/json

Successful Response

contact_variables

Contact Variables · object

required

Custom variables stored on the contact for this workspace.

Hide child attributes

contact_variables.{key}

string | null

account_variables

Account Variables · object

required

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

Hide child attributes

account_variables.{key}

string | null

Delete Contact Variable

curl --request DELETE \
  --url https://api.topo.io/v1/contacts/{contact_id}/variables/{key} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

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

import requests

url = "https://api.topo.io/v1/contacts/{contact_id}/variables/{key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "contact_variables": {},
  "account_variables": {}
}