Email Templates

View markdown

Email Templates

Email templates hold a subject line, HTML content, and performance stats like open and click rates. They are used in sequences, workflows, and broadcasts. Use this API to fetch template details and update template content.

Available Endpoints

The Email Template Model

The email template model represents a reusable email with its content and performance statistics.

Properties

  • Name
    idinteger
    Description

    The unique identifier for the template

  • Name
    namestring
    Description

    The name of the template

  • Name
    subjectstring
    Description

    The email subject line

  • Name
    htmlstring
    Description

    The HTML content of the email

  • Name
    created_atdatetime
    Description

    When the template was created

  • Name
    statsobject
    Description

    Performance statistics including open_rate and click_rate

Get Email Template

GET/v1/fetch/emails/templates/:id

Retrieves a single email template by its ID, including the full HTML content and performance statistics.

Path Parameters

  • Name
    idintegerRequired
    Description

    The template ID

Query Parameters

  • Name
    site_uuidstringRequired
    Description

    Your site's unique identifier



Response

Returns the email template with its full content and stats.

  • Name
    data.idinteger
    Description

    Email template ID.

  • Name
    data.typestring
    Description

    Resource type, typically email_template.

  • Name
    data.attributes.namestring
    Description

    Template name.

  • Name
    data.attributes.subjectstring
    Description

    Template subject line.

  • Name
    data.attributes.htmlstring
    Description

    Template HTML.

  • Name
    data.attributes.statsobject|null
    Description

    Performance stats when available.

Update Email Template

PATCH/v1/fetch/emails/templates/:id

Updates an existing email template. You can update the subject line, HTML content, editor type, or any combination.

Only the fields you include in the request will be updated. Omitted fields remain unchanged.
If you omit type, the template keeps its current editor.

Path Parameters

  • Name
    idintegerRequired
    Description

    The template ID

Query Parameters

  • Name
    site_uuidstringRequired
    Description

    Your site's unique identifier

Request Body

  • Name
    email_template.subjectstring
    Description

    The new email subject line (optional)

  • Name
    email_template.htmlstring
    Description

    The new HTML content (optional)

  • Name
    email_template.typestring
    Description

    The editor type. plain for Bento's CSS or raw to use your own HTML (optional)



Response

Returns the updated email template.

  • Name
    data.idinteger
    Description

    Updated email template ID.

  • Name
    data.attributes.subjectstring
    Description

    Updated subject line.

  • Name
    data.attributes.htmlstring
    Description

    Updated HTML content.