Skip to content

Area: Developers

POST

Mark a message as read

Path
/inbox/messages/{messageId}/read
Auth
Access token · browser or app
POST
/inbox/messages/{messageId}/read
curl --request POST \
--url https://releva.ai/api/v0/inbox/messages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "userId": "DEMO-CUSTOMER-1001" }'

Marks one message as read and records an inboxMessageRead event. Marking a message that is already read answers 202 again and records nothing.

messageId
required
string format: uuid

The message id from the list response (a delivery id, not inboxMessageId).

Send as application/json. Without that content type the body is not read and the call answers 400.

Media typeapplication/json
object
userId
required
string
>= 1 characters <= 96 characters

Example

{
"userId": "DEMO-CUSTOMER-1001"
}

Accepted for asynchronous processing.

Media typeapplication/json
object
0

Example

{}

Authentication error, or userId missing or longer than 96 characters.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Authorization header is missing",
"and accessToken url parameters is also missing. At least one of them is required.": null
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

No message with this id for this userId in this shop.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Message not found."
}

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.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}