Skip to main content
POST
Map a channel

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The Worker id. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
clientSlug
string
required

The Client this room's traffic belongs to.

channel
string

The room — an id (C…/G…) or a name (ops). A DM id (D…) is refused: a DM resolves its Client through the sender's binding. Exactly one of channel and slackChannelId is required.

slackChannelId
string

The spelling this call shipped with. Takes the same values as channel.

name
string

The channel's name, for display.

confirm
boolean

Required to move a channel that is already mapped to a different Client.

Response

Success.

data
object
required