API Reference

Mark Message As Read – Updates the status of an inbox message to 'read' for an account.

put
https://example.com/programs//accounts//inbox/messages

Updates the status of an inbox message to 'read' for an account. Requires account identifier, program code, and message details. Returns the status and details of the update operation.

Path Params
string
required

The unique code identifying the partner program context for which the message status is updated.

string
required

The unique identifier of the account whose message status is being updated.

Body Params

The Gd.Bos.DataTransfer.Request.MarkMessageAsReadRequest object containing message identifiers and update details.

messages
array of objects | null

The list of messages to be marked as read. Each Gd.Bos.DataTransfer.ReadMessage entry specifies the message key and the status to be updated.

messages
Headers
string
required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago