email-messages

Get stored message content

Returns the stored HTML and text bodies for a sent message. Content storage must be enabled for the message. Content is available for up to 30 days after sending. A broadcast stores no body, so a copy the send has recorded always answers 404, whatever the workspace has configured. A 404 indicates no content was stored for this message. A scheduled send of a workspace template, rather than a built-in one, stores its content when it sends, so it answers 404 until then. A 425 indicates the content is still being stored and the request can be retried shortly. A 410 indicates the content was stored but has since expired.

get/v1/email/messages/{message_id}/content

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/messages/{message_id}/content
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

message_idstring required
Example:em_01krdgeqcxet5s7t44vh8rt9mg

ID of the message whose stored content to fetch. A broadcast records one message per recipient, and List email messages returns those copies alongside ordinary sends. For a single send, this is the message's own ID, from the send response's id field.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Stored message content.

htmlstring

The HTML body of the message as delivered, if it was stored.

textstring

The plain-text body of the message as delivered, if it was stored.

Example response

{
  "html": "<p>Hi Jane,</p><p>Your order #1234 has shipped and is on its way.</p>",
  "text": "Hi Jane,\n\nYour order #1234 has shipped and is on its way."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.