Schedule an SMS for a future time (LiveChat, Allison, sequences)

Every /api/trigger route (send-sms, schedule-message-wait, schedule-message, schedule-recurring, schedule-delay, schedule-until, cancel-job, job-status) requires EITHER a verified Supabase session (Authorization: Bearer <access_token>) of a current member of workspaceId (body; query on GET), OR X-Internal-Service-Key equal to the backend's INTERNAL_SERVICE_KEY (backend-to-backend; refused when unset). API keys are refused. cancel-job / job-status also answer 403 for a job of another workspace.

POST

https://api.channelautomation.com/api/trigger/schedule-until

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Request body JSON required

to
string
required
body
string
required
workspaceId
string
required
scheduledTime
string
required
format: date-time
contactId
optional
string
mediaUrl
optional
string

Returns

200

Scheduled

400

Missing fields

401

No verified session / invalid internal key

403

Not a member of workspaceId

Schedule an SMS for a future time (LiveChat, Allison, sequences)

curl --request POST \
  --url https://api.channelautomation.com/api/trigger/schedule-until \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "string",
  "body": "string",
  "workspaceId": "string",
  "scheduledTime": "2019-08-24T14:15:22Z",
  "contactId": "string",
  "mediaUrl": "string"
}
'

const url = 'https://api.channelautomation.com/api/trigger/schedule-until';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    to: 'string',
    body: 'string',
    workspaceId: 'string',
    scheduledTime: '2019-08-24T14:15:22Z',
    contactId: 'string',
    mediaUrl: 'string'
  })
};

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/trigger/schedule-until"

payload = {
    "to": "string",
    "body": "string",
    "workspaceId": "string",
    "scheduledTime": "2019-08-24T14:15:22Z",
    "contactId": "string",
    "mediaUrl": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)