email-inbound-messages

Get a received email's body

Returns the parsed, decoded body of a received email as JSON: the html and text parts, each null when the message had no such part. This is the reading-friendly form. For the exact original bytes (headers, signatures, full MIME structure) use Get a received email's raw content. An unknown or expired message returns 404. A message that exists but has no stored content returns both parts null.

get/v1/email/inbound-messages/{inbound_message_id}/body

Request

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

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

Parsed message body.

htmlstring nullable required

The HTML body of the message, or null when the message had no HTML part.

textstring nullable required

The plain-text body of the message, or null when the message had no text part.

Changes

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