Skip to content

Notifications

Create, publish, and inspect notification templates, their groups, and versions.

Fields

idstringUnique identifier of the resource.
namestring
statusenumdraft · active · archived
keystring
groupstring
notificationenumemail · sms · push · whatsApp · inApp · webhook
localestring
versioninteger
See all 16 fields
subjectTplstring
exampleDatastring
bodyTplstring
textTplstring
canDisableboolean
isEnabledboolean
tenantIdstring
storeIdstring

Operations

MethodEndpointOperation
POST/v1/notifications/templatesCreate template
GET/v1/notifications/templatesList templates
GET/v1/notifications/templates/{templateId}Get template by ID
GET/v1/notifications/templates/{templateKey}Get template
GET/v1/notifications/templates/groupsList template groups
PUT/v1/notifications/templates/{id}Update draft template
POST/v1/notifications/templates/{id}/disableStop sending this notification
POST/v1/notifications/templates/{id}/enableSend this notification again
POST/v1/notifications/templates/{id}/publishPublish template
GET/v1/notifications/templates/{templateId}/versionsList template versions by ID
GET/v1/notifications/templates/{templateKey}/versionsList template versions by key

Last updated: