Schedule an email for delivery

Schedules an email to be sent via the queue service

POST

https://api.channelautomation.com/api/queue/schedule-email

Authorization

bearerAuth
bearerAuth
required

Request body JSON required

to
string
required
Recipient email address

format: email
subject
string
required
Email subject
body
string
required
Email body (HTML supported)
workspaceId
string
required
Workspace ID
contactId
optional
string
Contact ID (optional)
scheduledFor
optional
string
When to send the email (optional, immediate if not specified)

format: date-time
metadata
optional
object
Additional metadata for the email

Returns

200

Email scheduled successfully

JSON

success
optional
boolean
jobId
optional
string
Queue job ID for tracking
scheduledFor
optional
string
When the email is scheduled to be sent

format: date-time

400

Invalid input

401

Unauthorized

500

Internal server error

Schedule an email for delivery

curl --request POST \
  --url https://api.channelautomation.com/api/queue/schedule-email \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "user@example.com",
  "subject": "string",
  "body": "string",
  "workspaceId": "string",
  "contactId": "string",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "metadata": {}
}
'

const url = 'https://api.channelautomation.com/api/queue/schedule-email';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    to: 'user@example.com',
    subject: 'string',
    body: 'string',
    workspaceId: 'string',
    contactId: 'string',
    scheduledFor: '2019-08-24T14:15:22Z',
    metadata: {}
  })
};

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/queue/schedule-email"

payload = {
    "to": "user@example.com",
    "subject": "string",
    "body": "string",
    "workspaceId": "string",
    "contactId": "string",
    "scheduledFor": "2019-08-24T14:15:22Z",
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

Response example

{
  "success": true,
  "jobId": "string",
  "scheduledFor": "2019-08-24T14:15:22Z"
}