Engagement Email

Render an email preview

Changed on

Render an email the way a recipient gets it, from unsaved editor values: emailStyle (plain, personal or company), subject, preheader, message (TipTap JSON, or { localized: { <lang>: doc } }), optional sender (a teammate id, or { customSenderName }), lang and brand (unsaved emailBrand values). The current user is the sample recipient and variables resolve with their values. Nothing is stored or sent.

post/engagement/emails/render-preview

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/emails/render-preview
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

emailStylestring required
subjectunknown
preheaderunknown
messageunknown
langstring
brandunknown
emailCategory'conversational' | 'marketing'

Conversational emails show no unsubscribe line. Defaults to marketing (a newsletter).

Response

Ok

sizeBytesnumber double required
textstring required
htmlstring required

Changes