Unarchive a channel | Sample

1 parameter · 1 body field

tokenstringrequired

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

Form data identifying the channel to unarchive. channel_id is required.

channel_idstringrequired

The channel to unarchive.

2 status codes

200Returns an object containing `ok: true` when the channel is unarchived.

okbooleanrequired

Allowed:true

defaultReturns an object containing `ok: false` and an `error` value when the channel cannot be unarchived.

errorstringrequired

Allowed:feature_not_enabledchannel_not_foundchannel_not_archivedchannel_type_not_supportedrestricted_actioncould_not_unarchive_channeldefault_org_wide_channelmissing_scope

okbooleanrequired

Allowed:false

Error handling

channel_id is required and must identify the public or private channel to unarchive. Use a token with the admin.conversations:write scope.

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

{
  "ok": true
}

Request

Response

Errors