Channels

Update a channel.

Required scope: channels:write

patch/channels/{channel_id}

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/channels/{channel_id}
  • Auth
    HTTP bearer

Path parameters

channel_idstring required

The Channel ID. Alternatively, you can supply the channel address as a resource alias.

Request body

namestring

Name of the channel

inbox_idstring

ID of the inbox to move this channel to. Will also move corresponding conversations.

Example request

{
  "name": "Your channel name"
}

Response

No content

Changes

    • breaking

      request body became required

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property