Disconnect a shared channel | Sample

1 parameter · 2 body fields

tokenstringrequired

Authentication token with the `admin.conversations:write` scope.

Form-encoded connected-channel disconnection request. channel_id is required.

channel_idstringrequired

The channel to be disconnected from some workspaces.

leaving_team_idsstringoptional

The team to be removed from the channel. Currently only a single team id can be specified.

2 status codes

200Returns an object with `ok` set to true when the connected channel is disconnected.

okbooleanrequired

Allowed:true

defaultReturns an object with `ok` set to false and an `error` value describing why the channel could not be disconnected.

errorstringrequired

Allowed:feature_not_enablednot_an_adminnot_an_enterprisechannel_not_foundnot_supportedteam_not_foundrestricted_actionmissing_scopeleaving_team_not_in_channelno_teams_to_disconnectleaving_team_requiredcannot_kick_team

okbooleanrequired

Allowed:false

Error handling

The token must carry the admin.conversations:write scope. channel_id must identify a connected channel, and leaving_team_ids can contain only a single workspace identifier when provided.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.adminConversationsDisconnectShared.create({
  channelId: "c0a80123-4567-89ab-cdef-0123456789ab",
  leavingTeamIds: "example",
});

{
  "ok": true
}

Request

Response

Errors