v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Notification

Get Inbox Message Count – Retrieves the count of inbox messages for an account, optionally filtered by status.

Get Inbox Message Count

get/programs/{programCode}/accounts/{accountIdentifier}/inbox/messages/count

Path parameters

programCodestring required

The unique code identifying the partner program context for which the message count is retrieved.

accountIdentifierstring required

The unique identifier of the account whose message count is being retrieved.

Query parameters

statusinteger

Optional. The status to filter messages by (e.g., unread, read). Valid values are defined in the message status enumeration.

sccAccountIdentifierstring

Optional. The unique identifier of the SCC account for cross-account message count retrieval.

Headers

X-GD-RequestIdstring required

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

Response

OK

countinteger nullable

The total number of inbox messages matching the request criteria. Used for notification badges, message analytics, or pagination.