> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gleap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Render the email editor canvas

> 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.



## OpenAPI

````yaml https://api.gleap.io/api-docs.json post /engagement/emails/render-canvas
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/emails/render-canvas:
    post:
      tags:
        - Engagement Email
      summary: Render the email editor canvas
      description: >-
        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.
      operationId: RenderEmailCanvas
      parameters:
        - in: header
          name: project
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenderCanvasBody'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  slot:
                    type: string
                  css:
                    type: string
                  html:
                    type: string
                required:
                  - slot
                  - css
                  - html
                type: object
      security:
        - jwt: []
components:
  schemas:
    RenderCanvasBody:
      description: >-
        Body of `render-canvas`: the preview body without the message, plus the
        editor's content selector.
      properties:
        sender:
          anyOf:
            - type: string
            - properties:
                customSenderName:
                  type: string
                id:
                  type: string
              type: object
          description: >-
            A teammate id, or `{ id?, customSenderName? }`. Defaults to the
            current user.
        lang:
          type: string
        emailStyle:
          type: string
        subject: {}
        preheader: {}
        brand:
          description: Unsaved `emailBrand` values from the brand settings page.
        emailCategory:
          type: string
          enum:
            - conversational
            - marketing
          description: >-
            Conversational emails show no unsubscribe line. Defaults to
            marketing (a newsletter).
        root:
          type: string
          description: >-
            CSS selector of the editor's content element, e.g. `#email-canvas
            .ProseMirror`.
      required:
        - emailStyle
        - root
      type: object
      additionalProperties: false
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.