Invite users to a channel | Sample

1 parameter · 2 body fields

tokenstringrequired

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

Form-encoded channel invitation details.

user_idsstringrequired

The users to invite.

channel_idstringrequired

The channel that the users will be invited to.

2 status codes

200Returns a successful response containing the `ok` flag after processing the invitation request.

okbooleanrequired

Allowed:true

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

errorstringrequired

Allowed:feature_not_enabledchannel_not_foundchannel_type_not_supporteddefault_org_wide_channelrestricted_actionuser_must_be_adminfailed_for_some_users

okbooleanrequired

Allowed:false

Error handling

token must provide the admin.conversations:write scope. The request body must include both user_ids and channel_id, and user_ids must identify the users to invite.

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

{
  "ok": true
}

Request

Response

Errors