Pause automation for a contact

Sets a contact-level automation pause and cancels currently active workflow and sequence runs for that contact.

POST

https://api.channelautomation.com/api/contacts/{contactId}/pause-automation

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

contactId
string
required
Contact ID to pause.

Header parameters

X-Workspace-Id
optional
string
Workspace context when the user has switched workspaces.

Request body JSON required

pauseHours
optional
1
or
2
or
3
pauseDays
optional
1
or
3
or
7
or
14
or
30
or
3650

Returns

200

Automation paused and active runs cancelled for the contact.

400

Invalid contact or pause duration.

401

Authentication required

JSON

error
optional
string
success
optional
boolean

404

Contact not found in the workspace.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Pause automation for a contact

curl --request POST \
  --url 'https://api.channelautomation.com/api/contacts/<contactId>/pause-automation' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pauseHours": 1,
  "pauseDays": 1
}
'

const url = 'https://api.channelautomation.com/api/contacts/<contactId>/pause-automation';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({pauseHours: 1, pauseDays: 1})
};

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/contacts/<contactId>/pause-automation"

payload = {
    "pauseHours": 1,
    "pauseDays": 1
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

Response example

{
  "error": "Authentication required",
  "success": false
}

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}