Unenroll Contacts
Remove contacts from outreach entirely.
POST
/
v1
/
contacts
/
unenroll
Unenroll Contacts
curl --request POST \
--url https://api.topo.io/v1/contacts/unenroll \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
sequence_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.topo.io/v1/contacts/unenroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contacts/unenroll"
payload = {
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"stopped_sequence_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stopped_count": 123
}Remove contacts from outreach entirely.
Every non-finished sequence of each contact is marked failed and manually
stopped — including leads still waiting for approval — and the contact is
excluded from all outreach for three months. Scope it to one template with
sequence_template_id.
This is not POST /v1/sequences/{sequence_id}/stop: that closes one
enrollment with an outcome (won or lost) and leaves the contact reachable.
Requires the sequences:write scope on the API key.Authorizations
Bearer API key issued from Settings → Developers.
Body
application/json
Unenroll Contacts payload
Was this page helpful?
⌘I
Unenroll Contacts
curl --request POST \
--url https://api.topo.io/v1/contacts/unenroll \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
sequence_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.topo.io/v1/contacts/unenroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.topo.io/v1/contacts/unenroll"
payload = {
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"stopped_sequence_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"stopped_count": 123
}