Get channel conversation preferences | Sample

2 parameters

channel_idstringrequired

Identifier of the public or private channel whose conversation preferences to retrieve.

tokenstringrequired

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

2 status codes

200Returns the `ok` flag and, when available, a `prefs` object containing channel posting preferences such as `can_thread` and `who_can_post`.

okbooleanrequired

Allowed:true

prefsobjectoptional

defaultReturned when the request cannot be processed successfully; the response contains `ok: false` and an error value.

errorstringrequired

Allowed:feature_not_enablednot_an_adminnot_an_enterpriserestricted_actionmissing_scopechannel_not_foundchannel_type_not_supportedcould_not_get_conversation_prefs

okbooleanrequired

Allowed:false

Error handling

token must provide the admin.conversations:read scope, and channel_id must identify the channel whose preferences you want to retrieve.

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

{
  "ok": true
}

Request

Response

Errors