Pause AI and cancel queued AI replies for a workspace contact

Requires a verified session, current workspace membership, and contact tenancy. Body userId and workspaceId are ignored; actor identity comes from the verified session.

POST

https://api.channelautomation.com/api/ai/conversation-state/{contactId}/takeover

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

contactId
string
required

Header parameters

X-Workspace-Id
optional
string
Selected workspace; defaults to session metadata but always verifies membership.

Returns

200

Action completed; success is true.

400

Missing workspace.

401

Missing or invalid session.

403

Not a workspace member.

404

Contact is outside the workspace or missing.

500

Mutation failed.

503

Access could not be verified; no mutation performed.

Pause AI and cancel queued AI replies for a workspace contact

curl --request POST \
  --url 'https://api.channelautomation.com/api/ai/conversation-state/<contactId>/takeover' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/ai/conversation-state/<contactId>/takeover';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/ai/conversation-state/<contactId>/takeover"

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

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

print(response.text)