Sign in
Slack channel activation

Transition a Slack channel to a target consent state (activate / pause / resume / revoke)

Changed on
patch/workspaces/{workspaceSlug}/slack/channels/{slackChannelId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/slack/channels/{slackChannelId}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

slackChannelIdstring required

Request body

consentState'PENDING' | 'ACTIVE' | 'PAUSED' | 'REVOKED' required

Target consent state

reasonstring

Optional free-text reason recorded in the immutable audit trail

Response

OK

channelNamestring

Human-readable channel name, if known

consentAnnouncedAtstring date-time

When the in-channel consent announcement was posted (stamped on first activation)

consentState'PENDING' | 'ACTIVE' | 'PAUSED' | 'REVOKED' required

Current per-channel consent lifecycle state

createdAtstring date-time required

When the channel was first discovered / allow-listed

idinteger required

Internal allow-list row id

optedOutMemberCountinteger required

Number of workspace members who have opted out of ingestion (workspace-wide)

slackChannelIdstring required

Slack channel id (stable C…/G… id; the natural key)

slackTeamIdstring required

Slack team (workspace) id the channel belongs to

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$