Skip to content

Message Template ​

omnichannel.template · every change is kept in the audit log · numbered {channel}-{slug}

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
channelchannelselectrequired; one of: Email, WhatsApp, SMS, Slack, Voice
namenametextrequired; max 120 characters
slugslugtextrequired; max 120 characters
descriptiondescriptiontextmax 300 characters
portalportallink → omnichannel.portal
statusstatusselectone of: Draft, Active, Archived; default "Draft"
current_versioncurrent versionnumberdefault 1; min 1
subjectsubjecttextmax 500 characters
bodybodylongtextrequired
variablesvariablesjson
provider_template_nameprovider template nametextmax 190 characters
provider_statusprovider statusselectone of: Not submitted, Pending, Approved, Rejected, Paused
logologoimage
versionsversionstable of template_version
attachmentsattachmentstable of template_attachment

Unique together: channel + slug

Permissions ​

RoleCan
omnichannel:adminread, create, update, delete, import, export
omnichannel:editorread, create, update
omnichannel:viewerread

API ​

http
GET    /api/omnichannel/template?<field>=<value>&limit=100&offset=0
POST   /api/omnichannel/template
GET    /api/omnichannel/template/:id
PATCH  /api/omnichannel/template/:id
DELETE /api/omnichannel/template/:id

Bulk import: GET /api/_import/omnichannel/template/template (CSV template), then POST /api/_import/omnichannel/template. See REST API.

Edulab Bench developer documentation