Method
PATCH /v1/comms/templates/:id
Path Parameters
uuid
required
Template ID.
Body Parameters
Headers
string
Bearer token (requires
comms:write).string
application/jsonRequest Example
curl -X PATCH "https://api.voyantcloud.com/v1/comms/templates/tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Booking Confirmation (Updated)",
"status": "active"
}'
await fetch("https://api.voyantcloud.com/v1/comms/templates/tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({ status: "inactive" }),
})
import os, requests
payload = {"name": "WhatsApp Campaign Q2"}
requests.patch(
"https://api.voyantcloud.com/v1/comms/templates/tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q",
headers={
"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}",
"content-type": "application/json",
},
json=payload,
)
Response Example
{
"id": "tmpl_01J0CBFPXW7SP2N8A9Q7T2048Q",
"workspace_id": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
"name": "Booking Confirmation (Updated)",
"key": "booking_confirmation",
"channel": "email",
"purpose": "transactional",
"status": "active",
"created_at": "2025-01-08T10:22:31.000Z",
"updated_at": "2025-02-10T09:18:04.000Z"
}
{ "error": "No updates provided" }
At least one field (
name or status) must be supplied; otherwise the API returns 400 with "No updates provided".