Stop follow-ups for a verified contact appointment

Requires the existing API-key/session gate or backend automation credential; public source labels no longer bypass authentication. All workspace selectors must agree. Automation requires an appointment; sessions/API keys may omit it. Any supplied appointment must belong to the URL contact. Existing session/API-key contact access is retained.

POST

https://api.channelautomation.com/api/workspaces/{workspaceId}/contacts/{contactId}/stop-sequences-on-appointment

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header
BackendTriggerAuth
optional
API key in header

Path parameters

workspaceId
string
required
contactId
string
required
format: uuid

Header parameters

X-Workspace-Id
optional
string

Request body JSON optional

appointmentId
optional
string
or null
format: uuid

Returns

200

Existing cancellation result

400

Missing or malformed appointment

401

Invalid or missing caller identity

403

Workspace conflict or contact visibility denied

404

Appointment or contact not found for this workspace/contact

503

Identity

Stop follow-ups for a verified contact appointment

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/contacts/<contactId>/stop-sequences-on-appointment' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appointmentId": "24c6adb3-18be-4108-aa61-3d58879e05a2"
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/contacts/<contactId>/stop-sequences-on-appointment';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({appointmentId: '24c6adb3-18be-4108-aa61-3d58879e05a2'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/contacts/<contactId>/stop-sequences-on-appointment"

payload = { "appointmentId": "24c6adb3-18be-4108-aa61-3d58879e05a2" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)