Skip to content
docs
Guides
ES
CatalogNotifications
notification:read

Get template

GET/v1/notifications/templates/{templateKey}

Get template. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

templateKey*string

Key of the template.

Query Parameters

channel*string

Sales channel code.

Value in

  • "email"
  • "sms"
  • "push"
  • "whatsApp"
  • "inApp"
  • "webhook"
locale?string

Language code for localized content.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/notifications/templates/example?channel=email" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "id": "7204558912004325301",  "tenantId": "7204558912004325301",  "key": "example",  "group": "example",  "name": "Example resource",  "notification": "email",  "version": 1,  "bodyTpl": "example",  "status": "draft"}