Engagement Email

Render the email editor canvas

Changed on

The editor canvas of an email: the email of the look (emailStyle) rendered around an empty body, with slot marking where the body goes, and css that styles the editor's content (TipTap markup under the root selector) like the renderer styles the body. Takes the same values as render-preview except message. Nothing is stored or sent.

post/engagement/emails/render-canvas

Request

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

Headers

projectstring required

Request body

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

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

rootstring required

CSS selector of the editor's content element, e.g. #email-canvas .ProseMirror.

Response

Ok

slotstring required
cssstring required
htmlstring required

Changes