Sign in
inbox

Get active inbox messages

Retrieve only active inbox messages

get/inbox/active

Response

Active inbox messages retrieved successfully

inbox_idnumber required

Inbox message ID

titlestring required

Message title

descriptionstring required

Message description

image_bannerstring

Banner image URL

deep_link_urlstring

Deep linking URL

published_datestring date-time required

Publication date

is_activeboolean required

Active status

priority'low' | 'normal' | 'high' | 'urgent' required

Priority level

expires_atstring date-time

Expiration date

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

languageType'BM' | 'EN' required

Language type

Example response

[
  {
    "inbox_id": 1,
    "title": "Important Update",
    "description": "This is an important system update",
    "image_banner": "https://example.com/banner.jpg",
    "deep_link_url": "https://example.com/update",
    "published_date": "2024-01-01T10:00:00.000Z",
    "is_active": true,
    "priority": "high",
    "expires_at": "2024-12-31T23:59:59.000Z",
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2024-01-01T10:00:00.000Z",
    "languageType": "EN"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.