Skip to main content

Method

PATCH /v1/comms/templates/:id

Path Parameters

id
uuid
required
Template ID.

Body Parameters

Headers

Authorization
string
Bearer token (requires comms:write).
content-type
string
application/json

Request 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"
  }'

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"
}
At least one field (name or status) must be supplied; otherwise the API returns 400 with "No updates provided".