Skip to main content
PATCH
Classify 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.

channel
string
required

A Slack channel id (C…/G…) or a channel name (ops). See Naming a room above.

Body

application/json
kind
enum<string>
required

internal routes the room to the Worker's core ework and mints nothing. client binds it to a Client and activates that pair's ework.

Available options:
internal,
client
clientSlug
string

Required when kind is client.

confirm
boolean

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

Response

Success — kind is internal, because nothing was started.

data
object
required