Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl -X POST "https://api.voyantcloud.com/v1/comms/templates" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Booking Confirmation",
"key": "booking_confirmation",
"channel": "email",
"purpose": "transactional",
"status": "active"
}'
const res = await fetch("https://api.voyantcloud.com/v1/comms/templates", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
name: "Payment Reminder",
key: "payment_reminder",
channel: "sms"
}),
})
const template = await res.json()
import os, requests
payload = {
"name": "WhatsApp Campaign",
"key": "promo_whatsapp_march",
"channel": "whatsapp",
"purpose": "marketing"
}
resp = requests.post(
"https://api.voyantcloud.com/v1/comms/templates",
headers={
"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}",
"content-type": "application/json",
},
json=payload,
)
created = resp.json()
{
"id": "tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q",
"workspace_id": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
"name": "Booking Confirmation",
"key": "booking_confirmation",
"channel": "email",
"purpose": "transactional",
"status": "active",
"created_at": "2025-01-08T10:22:31.000Z",
"updated_at": "2025-01-08T10:22:31.000Z"
}
Create a new communication template metadata record.
POST /v1/comms/templates
comms:write).application/jsoncurl -X POST "https://api.voyantcloud.com/v1/comms/templates" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Booking Confirmation",
"key": "booking_confirmation",
"channel": "email",
"purpose": "transactional",
"status": "active"
}'
const res = await fetch("https://api.voyantcloud.com/v1/comms/templates", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
name: "Payment Reminder",
key: "payment_reminder",
channel: "sms"
}),
})
const template = await res.json()
import os, requests
payload = {
"name": "WhatsApp Campaign",
"key": "promo_whatsapp_march",
"channel": "whatsapp",
"purpose": "marketing"
}
resp = requests.post(
"https://api.voyantcloud.com/v1/comms/templates",
headers={
"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}",
"content-type": "application/json",
},
json=payload,
)
created = resp.json()
id – Template ID.workspace_id – Workspace owning the template.name, key, channel, purpose, status – Echoed metadata.created_at, updated_at – ISO timestamps.{
"id": "tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q",
"workspace_id": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
"name": "Booking Confirmation",
"key": "booking_confirmation",
"channel": "email",
"purpose": "transactional",
"status": "active",
"created_at": "2025-01-08T10:22:31.000Z",
"updated_at": "2025-01-08T10:22:31.000Z"
}
409 with error code TEMPLATES_DUPLICATE. Choose a unique key per workspace.