Sign in

v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB
Email messages

Get an email message

Retrieve an email message, including its compiled LMX content.

get/v1/email-messages/{emailMessageId}

Response

Successful.

idstring required

The ID of the email message.

campaignIdstring

The campaign this email message belongs to. Present only when the message belongs to a campaign (mutually exclusive with transactionalId).

transactionalIdstring

The transactional email this email message belongs to. Present only when the message belongs to a transactional email (mutually exclusive with campaignId).

subjectstring required

The email subject.

previewTextstring required

The email preview text.

fromNamestring required

The email sender name.

fromEmailstring required

The email sender email address, without the team's sending domain.

replyToEmailstring required

The email reply-to address.

ccEmailstring

The email CC address. Only present when set.

bccEmailstring

The email BCC address. Only present when set.

languageCodestring

Only present when set.

emailFormat'styled' | 'plain' required

The rendering format of the email.

lmxstring required

The email body serialized as LMX.

contentRevisionIdstring nullable required

The current content revision. Pass this as expectedRevisionId on your next update.

updatedAtstring date-time required
contactPropertiesFallbacksobject

Fallback values for contact properties. Only present when set.

eventPropertiesFallbacksobject

Fallback values for event properties. Only present when set.

dataVariablesFallbacksobject

Fallback values for data variables. Only present when set.

Example response

{
  "id": "cle5f7g9h1i3j5k7l9m1n3p5",
  "campaignId": "clc4m6n8p0q2r4s6t8u0v2x4",
  "subject": "Spring product updates",
  "previewText": "See what's new this season",
  "fromName": "Acme Team",
  "fromEmail": "hello",
  "replyToEmail": "support@company.com",
  "emailFormat": "styled",
  "lmx": "<Paragraph>Hello, {firstName}!</Paragraph>",
  "contentRevisionId": "clrev1s10n2i3d4e5f6g7h8",
  "updatedAt": "2025-06-29T07:47:39.370Z"
}