Rename or re-scope a channel

PATCH

/api/chat/channels/{channelId}

• Production
• Local Development

Owners and managers only. Pass null for a role list to clear the restriction.

Authorizations

• bearerAuth

Parameters

Path Parameters

channelId

required

string format: uuid

Request Body

Fields to change

object

name

string

>= 1 characters <= 100 characters

visibleToRoles

Array<string>

nullable >= 1 items

Allowed values: owner manager member guest tech

postRoles

Array<string>

nullable >= 1 items

Allowed values: owner manager member guest tech

Responses

200

Updated

object

ok

required

boolean

data

nullable

400

Invalid input

object

ok

required

boolean

error

required

string

code

string

401

Unauthenticated

object

ok

required

boolean

error

required

string

code

string

403

Forbidden

object

ok

required

boolean

error

required

string

code

string

404

Channel not found

object

ok

required

boolean

error

required

string

code

string

409

A channel with that name already exists

object

ok

required

boolean

error

required

string

code

string

500

Server error

object

ok

required

boolean

error

required

string

code

string