Render an email message as HTML - Loops

POST

/

v1

/

email-messages

/

{emailMessageId}

/

render

curl --request POST \
  --url https://app.loops.so/api/v1/email-messages/{emailMessageId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactProperties": {
    "firstName": "Alex"
  }
}
'

{
  "html": "<!doctype html><html>...</html>"
}

{
  "message": "Email message not found."
}

{
  "message": "Email message not found."
}

Render an email message as HTML without sending it. The HTML is the same as the body of a preview email. Accepted variable fields depend on the parent’s type:

Campaign accepts contactProperties.
Workflow accepts contactProperties and eventProperties.
Transactional accepts dataVariables.

Supplying a field the parent cannot reference results in a 400 Bad Request error. A variable without a value uses its fallback, or shows a missing-value marker as in a preview email. The HTML has no open tracking pixel. As in a preview email, the unsubscribe link opens a page that does not unsubscribe anyone.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

emailMessageId

string

required

The ID of the email message.

Example:

"cle5f7g9h1i3j5k7l9m1n3p5"

Body

application/json

contactProperties

object

Contact property values to render. Accepted for campaign and workflow emails.

Show child attributes

Example:

{ "firstName": "Alex" }

eventProperties

object

Event property values to render. Accepted for workflow emails only.

Show child attributes

Example:

{ "planName": "Pro" }

dataVariables

object

Transactional data variables to render. Accepted for transactional emails only.

Show child attributes

Example:

{
  "loginUrl": "https://app.company.com/login"
}

Response

Rendered email message.

html

string

required

The rendered HTML. For emails made in the editor, it includes the rendered subject in <title> and the rendered preview text.

Example:

"<!doctype html><html>...</html>"

⌘I

curl --request POST \
  --url https://app.loops.so/api/v1/email-messages/{emailMessageId}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactProperties": {
    "firstName": "Alex"
  }
}
'

{
  "html": "<!doctype html><html>...</html>"
}

{
  "message": "Email message not found."
}

{
  "message": "Email message not found."
}