Send a SendGrid test email

Sends a one-off test email for the current workspace's active SendGrid configuration. Builder merge fields are not contact-resolved in this test path, but unsubscribe placeholders are converted into a safe test link so raw tokens are not delivered.

POST

https://api.channelautomation.com/api/sendgrid/send-test-email

Header parameters

x-workspace-id
string
required
Workspace id whose SendGrid configuration should be used.

Request body JSON required

to_email
string
required
format: email
subject
optional
string
html
optional
string

Returns

200

Test email sent successfully.

400

Missing recipient or SendGrid is not configured.

500

Failed to send test email.

Send a SendGrid test email

curl --request POST \
  --url https://api.channelautomation.com/api/sendgrid/send-test-email \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: string' \
  --data '
{
  "to_email": "user@example.com",
  "subject": "string",
  "html": "string"
}
'

const url = 'https://api.channelautomation.com/api/sendgrid/send-test-email';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'x-workspace-id': 'string'},
  body: JSON.stringify({to_email: 'user@example.com', subject: 'string', html: '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/sendgrid/send-test-email"

payload = {
    "to_email": "user@example.com",
    "subject": "string",
    "html": "string"
}
headers = {
    "Content-Type": "application/json",
    "x-workspace-id": "string"
}

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

print(response.text)