Skip to main content

​
Endpoints

MethodPathDescription
GET/v1/comms/templatesList communication templates for the workspace with optional filters.
POST/v1/comms/templatesCreate a template (name, key, channel, purpose, status).
GET/v1/comms/templates/:idRetrieve template metadata by ID.
PATCH/v1/comms/templates/:idUpdate template name or status.
DELETE/v1/comms/templates/:idDelete a template (requires comms:delete).
Workspace-scoped API keys are required. Read routes need comms:read; create/update routes require comms:write; deletion requires comms:delete.

​
Key concepts

  • Templates are metadata records (name, key, channel, purpose, status) used by downstream email/SMS delivery services. Versioned content (subject/body, WYSIWYG JSON) is handled separately.
  • channel identifies the delivery medium (email, sms, whatsapp, push_notification, etc.).
  • purpose differentiates transactional vs marketing messages; defaults to transactional on create.
  • status controls availability (draft, active, inactive, archived).
  • Webhooks fire on create/update/delete events (notification.template.*) so integrators can sync changes.