Messages archive setup

The messages archive lets you view and retrieve messages sent to your customers—either through the platform UI or via the API. This guide covers how to enable access for both.

Messages archive under customer profile

Use the Messages archive tab on a customer profile to browse, filter, and view sent messages directly in the platform.

📘

Note

This is a paid feature. Contact your CSM to enable the message archive for your account.

Roles and permissions

Messages archive in the UI

Use the Messages archive tab on a customer profile to browse, filter, and view sent messages directly in the platform.

Configure permissions

1. Go to Project settings.

2. Under Access management, go to Roles and assign the Customers Viewer role to users who need basic archive access.

3. Assign the Personal Data Viewer role to users who need to view full message content and recipient metadata.

Access the messages archive

1. Open a customer profile.

2. Go to the Messages archive tab.

3. Filter messages by channel and sent date.

4. Search by subject line, sender, or campaign name.

5. Click a message to view its details and content.

6. Select Download or Copy message to save the content.

Messages archive via API

Use the messages archive API to programmatically list and retrieve messages for a specific customer or across your entire project.

Configure permissions

To set up API group permissions for the messages archive, follow the steps in Setting up API groups.

Access the messages archive

Use the Data API endpoints under /data/v2/projects/<project_id>/message-archive/. Authenticate using basic authentication with your API key ID and secret key.

Available endpoints

• List messages for a specific customer: Look up messages by customer ID or recipient. Ideal for integrations with customer support portals or point-of-sale systems.

• List messages across a project: List or download all messages per project. Useful when you need to store messages outside the two-year retention window.

• Get a single message: Retrieve the full data (metadata and content) for a specific message. Use it in combination with the list endpoint, which returns the message_id and customer_id needed to query a single message. For email, the full HTML is only returned by this endpoint. The list endpoint returns metadata, subject, and preheader only.

See the Messages archive API for full endpoint documentation.