Archive a channel | Sample

1 parameter · 1 body field

tokenstringrequired

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

Form-encoded channel archiving request.

channel_idstringrequired

The channel to archive.

2 status codes

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

okbooleanrequired

Allowed:true

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

errorstringrequired

Allowed:feature_not_enabledchannel_not_foundchannel_type_not_supporteddefault_org_wide_channelalready_archivedcant_archive_generalrestricted_actioncould_not_archive_channel

okbooleanrequired

Allowed:false

Error handling

The token must carry the admin.conversations:write scope. channel_id must identify the public or private channel to archive.

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.adminConversationsArchive.create({ channelId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "ok": true
}

Request

Response

Errors