Update Work Channel
PATCH /work/channels/{channel_id}
Change one channel’s display name, description, visibility, seating, agent policy or archive state.
Field PRESENCE is the contract — an omitted field keeps its stored value,
and description: null clears it.
name is not accepted and a rename never moves the room: the slug is the
channel’s address, and changing it would strand every event already filed
under the old one. 403 when the caller neither owns the channel nor
holds owner/admin rights, and separately when a non-admin tries to change
agent activation — an organization-level spend decision rather than a
room-owner one. 409 for a built-in channel’s identity or visibility.
Authorizations
Parameters
Path Parameters
Channel id or slug
Channel id or slug
Header Parameters
Request Body required
The fields of one channel a person is changing.
Field PRESENCE is the contract, not field value. An omitted field keeps
whatever the channel already has; a field present with null clears it
where clearing is meaningful (description) and is refused where it is not.
That is the port of the gateway’s Object.hasOwn(input, …) checks, and it
is why provided_fields — not the values — is what the router hands the
service.
object
A channel’s icon: a glyph on a color, an emoji, or an uploaded image.
glyph and color are ids from the client’s curated sets, never raw CSS
or SVG, so nothing a member stores can inject markup or styles into
another member’s sidebar. An image is a Work attachment id, never a URL:
readability is re-checked on every read (readable_attachment_ids).
Responses
200
Successful Response
object
The result of one channel write, with its idempotent-replay marker.
object
One Work channel as the room stores it.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error