Work

Update Work Channel

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.

patch/work/channels/{channel_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/work/channels/{channel_id}
  • Auth: HTTP bearer

Path parameters

channel_idstring required

Channel id or slug

Headers

Idempotency-Keystring nullable

Retry-safety key. Replaying one returns the ORIGINAL result with duplicate: true instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

displayNamestring nullable
descriptionstring nullable
visibility'open' | 'private' nullable
memberUserIdsstring[]
participantAgentIdsstring[]
agentResponsePolicy'mention_required' | 'proactive' nullable
confirmAgentAccessboolean
archivedboolean nullable

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.