Preview an email

post

https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/preview

Render an email type with sample data, without sending. Content you send is used for this preview only and isn't saved; anything you leave out comes from the saved template. Merge fields get their sample values, and [partnerTitle] your real white-label title.

Prerequisites: a bearer token, the account's id (company_id) and the email type from List email types.

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422. The account's partner must have the email templates section turned on; otherwise 403. Types managed centrally by the platform return 403.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

company_id

integer

required

Defaults to 5994

The account. Must exist and be inside your account tree.

type

string

enum

required

Defaults to user_welcome

The email type, from List email types.

header

string

The header region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

body

string

Defaults to PHA+SGVsbG8gW2N1c3RvbWVyTmFtZV08L3A+

The body region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

footer

string

The footer region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

signature

string

The signature region. Base64-encoded HTML, up to 80,000 characters. Only merge fields from List an email's merge fields for this type are allowed. Left out: the saved version is used.

subject_override

string

length ≤ 255

Defaults to Welcome to [partnerTitle]!

The subject, as plain text (not base64), up to 255 characters. Merge fields allowed. Left out: the saved subject is used.

template_mode

string

enum

Defaults to regions

regions (header, body, footer and signature) or html (one full-HTML body in custom_html). Left out: the saved mode is used.

Allowed:

custom_html

string

The full-HTML body for html mode, base64-encoded, up to 400,000 characters. Left out: the saved version is used.

show_logo

boolean

Defaults to true

Show (true) or hide (false) the logo for this preview only. Left out: the saved setting is used.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The rendered email.

401The token is missing, expired or invalid.

403The email templates section is off for this account, or the type is managed centrally.

422company_id or type is missing or invalid, a region uses a merge field that isn't valid for this type, or the account is outside your tree.

500Unexpected server error.