Retrieve the source of a campaign message

Render a campaign message and return the generated email. This is the v3 equivalent of the source and structured actions of the v1 campaign_send action.

With structured=0 (the default) the rendered message is returned as one raw MIME string in result. With structured=1 the message is parsed and its headers, parts and attachments are returned as separate members alongside the raw source.

Rendering personalizes the message for email; the default address [email protected] renders the message without a contact. No email is delivered by this endpoint.

The account must have the Campaigns module enabled, otherwise the request answers 403.

Query Params
int32
required

ID of the campaign the message belongs to.

int32
required

ID of the message to render. Use the message id of the campaign, or 0 for a non-split campaign.

string
Defaults to [email protected]

Address the message is personalized for. Must be a valid email address; an invalid value answers 400.

string
enum
Defaults to mime

Which part of a MIME message to render. Any other value answers 400.

Allowed:
int32
enum
Defaults to 0

Set to 1 to receive the parsed representation instead of the raw MIME source.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json