CatalogNotifications
Preview template with sample data
Renders the stored template, or the content sent in the body, with the sample data of its event and the store branding used by real sends.
POST
/v1/notifications/templates/{templateId}/previewRenders the stored template, or the content sent in the body, with the sample data of its event and the store branding used by real sends.
Authorization
bearerAuth AuthorizationBearer <token>
OAuth2 access token issued by Ecomiq Auth.
In: header
Path Parameters
templateId*string
Identifier of the template.
Header Parameters
x-Store-Id?string
Store the request acts on. Not needed when the token is bound to a store.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/notifications/templates/7204558912004325301/preview" \ -H "x-Store-Id: <store-id>" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{ "subjectTpl": "example", "bodyTpl": "example", "textTpl": "example" }'{ "subject": "example", "body": "example", "text": "example"}