email-messages

Get a message attachment

Downloads the raw bytes of one attachment from a sent message, returned with the attachment's own content type and a Content-Disposition header that includes its filename. The message must have content storage enabled and the attachment is available for up to 30 days after sending. A 404 indicates the message has no stored content or no attachment with this ID. A 425 indicates the attachment is still being stored and the request can be retried shortly. A 410 indicates the attachment was stored but has since expired.

get/v1/email/messages/{message_id}/attachments/{attachment_id}

Request

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

Path parameters

message_idstring required
Example:em_01krdgeqcxet5s7t44vh8rt9mg

ID of the message the attachment belongs to, from the send response's id field.

attachment_idstring required
Example:ea_01krdgeqcxet5s7t44vh8rt9mg

Attachment ID, as returned in the message's attachments list.

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

The raw attachment bytes.

Changes

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