List inbox messages
- Path
/inbox/messages- Auth
- Access token · browser or app
const url = 'https://releva.ai/api/v0/inbox/messages?userId=DEMO-CUSTOMER-1001&limit=20';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://releva.ai/api/v0/inbox/messages?userId=DEMO-CUSTOMER-1001&limit=20' \ --header 'Authorization: Bearer <token>'Returns the shopper’s active, unexpired messages, newest first. Use nextCursor to fetch the next page;
it is null on the last page. Deleted and expired messages are never returned.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The shopper’s profile id (the value the app passed to setProfileId).
Page size. Default 20, maximum 50 (larger values are capped). 0 or a non-numeric value means 20.
Negative values currently cause a 500; send a value from 1 to 50.
The nextCursor value from the previous page. Opaque. An invalid cursor is ignored and the first page is returned.
Responses
Section titled “Responses”One page of messages.
object
object
Message (delivery) id. Use it in the read
Title
Message body as Unlayer design JSON, personalised when the message was sent. Render it with the SDK.
When the message was delivered.
Id of the message template. The same for every shopper who got this message; push payloads refer to it.
Pass as cursor to get the next page. null on the last page.
Example
{ "messages": [ { "id": "fe9db61a-b2ef-491e-bae7-e96735072932", "title": "Summer sale starts today", "design": { "body": { "id": "demo", "rows": [ { "id": "row-1", "cells": [ 1 ], "values": {}, "columns": [ { "id": "col-1", "values": {}, "contents": [ { "id": "text-1", "type": "text", "values": { "text": "<p>Take 20% off linen shirts until Sunday.</p>" } } ] } ] } ], "values": {} }, "counters": {}, "schemaVersion": 16 }, "read": false, "createdAt": "2026-10-21T19:18:20.804Z", "inboxMessageId": 2 } ], "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTIxVDE5OjE4OjIwLjgwNFoiLCJpZCI6ImZlOWRiNjFhLWIyZWYtNDkxZS1iYWU3LWU5NjczNTA3MjkzMiJ9"}Authentication error, or userId missing or longer than 96 characters.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Authorization header is missing", "and accessToken url parameters is also missing. At least one of them is required.": null}{ "message": "Authorization header is malformed. It should look like `Bearer <string>`."}{ "message": "The access token you provided is invalid."}{ "message": "Domain with the provided access token cannot be found."}{ "message": "A valid userId is required."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}Unexpected error. Currently also returned for malformed input: a messageId that is not a UUID, a userId
that is not a string, userId only in the query string of a POST or DELETE, or a negative limit.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}