Get a single archived message

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns full metadata and content for a specific archived message. Use the message_id and customer_id from a list endpoint's response to query it. For email, this is the only endpoint that returns the full HTML (the list endpoint only returns the metadata, subject, and preheader).

Authentication and access work the same as the list messages endpoint.

⚠️

Warning

This endpoint applies a rate limit of 300 requests per minute. If this is reached, the endpoint returns 429 Too Many Requests with the following headers:

  • Retry-After: <seconds> : how long until the window resets.
  • X-RateLimit-Limit : the limit value.
  • X-RateLimit-Remaining : remaining requests in the window.
  • X-RateLimit-Reset : UNIX timestamp when the window resets.

Request body examples

{
  "customer_id": "60b8d295f1a2c3001f9e4a12",
  "message_id": "65a1b2c3d4e5f60011223344",
  "channel": "email"
}

Response examples

{
  "success": true,
  "data": {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customer_id": "60b8d295f1a2c3001f9e4a12",
    "message_id": "65a1b2c3d4e5f60011223344",
    "channel": "email",
    "sender": "[email protected]",
    "recipient": "[email protected]",
    "subject": "Welcome to our platform",
    "sent_timestamp": 1705000000.0,
    "campaign_name": "Onboarding",
    "campaign_id": "64f1a2b3c4d5e60011223344",
    "action_id": 1,
    "action_name": "Welcome email",
    "sender_name": "Company",
    "preheader": "Get started with your new account",
    "email": "<html><body><h1>Welcome!</h1></body></html>",
    "attachments": [
      {
        "filename": "guide.pdf",
        "size": 102400,
        "content_type": "application/pdf"
      }
    ]
  }
}
{
  "success": true,
  "data": {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customer_id": "60b8d295f1a2c3001f9e4a12",
    "message_id": "65a1b2c3d4e5f60011223355",
    "channel": "sms",
    "sender": "+1234567890",
    "recipient": "+0987654321",
    "subject": null,
    "sent_timestamp": 1705000000.0,
    "campaign_name": "SMS Promo",
    "campaign_id": "64f1a2b3c4d5e60011223355",
    "action_id": 2,
    "action_name": "Promo SMS",
    "message": "Hi! Check out our latest offers."
  }
}

Email data fields

The email data includes all the email metadata fields (same as the list response), and the following content fields:

FieldTypeDescriptionExample
emailstring | nullFull HTML content of the email. The integrated tracking pixel is stripped.<html><body>...</body></html>
attachmentsarray | nullArray of objects with attachment metadata. It doesn't include the file content.See the attachments object's fields below.

Each object in the attachments array has the following fields:

FieldTypeDescriptionExample
filenamestringOriginal filename.guide.pdf
sizeintegerSize in bytes.102400
content_typestringMIME type.application/

SMS data fields

The SMS data includes all the SMS metadata fields (same as the list response), and the following content field:

FieldTypeDescriptionExample
messagestring | nullText body of the SMS.Hi! Check out our latest offers.
📘

Note

The standard message archive error responses also apply to this endpoint.


Body Params
string
required

Customer ID from the /list response.

string
required

Message ID from the /list response.

string
enum
required

email or sms.

Allowed:
Headers
string
required
Defaults to Basic <base64(api_key_id:secret_key)>
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.