Email

Preview an email template

The template filled with data, in the style of the site, without sending anything. missing_variables lists what has no value.

post/email-templates/{id}/preview

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-templates/{id}/preview
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:read)

Path parameters

idstring uuid required

The id of the template.

Request body

dataobject

The values for the variables, like { "name": "Sam", "order_number": "1042" }. Text, numbers or true/false.

Response

The subject, html and text as they would be sent.

subjectstring required
htmlstring nullable required
textstring nullable required
missing_variablesstring[] required

Variables without a value in data and without a fallback ({{name|there}}); they come out empty.

Changes

No recorded changes to this operation across all 1 revision of this API.