Inboxes

Update an inbox

Changed on

Updates the basics of an inbox.

patch/inboxes/{inboxId}

Request

  • Base URL
    https://api.superchat.com/v1.0
  • URL
    https://api.superchat.com/v1.0/inboxes/{inboxId}
  • Auth
    API key in header X-API-KEY

Path parameters

inboxIdstring required

Public ID of the inbox.

Request body

namestring required

The updated name of the inbox

emojistring nullable

The updated emoji of the inbox

descriptionstring nullable

The updated description of the inbox

timezonestring nullable

The updated timezone of the inbox

Response

OK

idstring required

The ID of the inbox

namestring required

The name of the inbox

emojistring nullable

The emoji of the inbox

descriptionstring nullable

The description of the inbox

timezonestring required

The timezone of the inbox

urlstring

The URL of the inbox resource

Changes