TOtonewow
inbox

Update an inbox message

Update an existing inbox message with optional new banner image. Any authenticated user can update.

patch/inbox/{id}

Request

  • Base URL
    https://api.tonewow.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.tonewow.com/inbox/{id}
  • Auth
    HTTP bearer

Path parameters

idnumber required
Example:1

Inbox message ID

Request body multipart/form-data

image_bannerstring binary

New banner image file (optional)

titlestring

Message title (optional)

descriptionstring

Message description (optional)

deep_link_urlstring

Deep linking URL (optional)

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

Priority level (optional)

expires_atstring date-time

Expiration date (ISO 8601) (optional)

is_activeboolean

Active status (optional)

Example request

{
  "title": "Updated Title",
  "description": "Updated description",
  "deep_link_url": "https://example.com/update",
  "priority": "urgent",
  "expires_at": "2024-12-31T23:59:59.000Z",
  "is_active": true
}

Response

Inbox message updated 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 operation across all 6 revisions of this API.