Remove a user from a conversation | Sample

1 parameter · 2 body fields

tokenstringoptional

Authentication token for the request; it must provide the `conversations:write` scope.

Optional form-encoded details identifying the conversation and user.

channelstringoptional

ID of conversation to remove user from.

userstringoptional

User ID to be removed.

2 status codes

200Returns a success object with `ok` set to true.

okbooleanrequired

Allowed:true

defaultTypical error response when you attempt to kick yourself from a channel

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:method_not_supported_for_channel_typemissing_scopechannel_not_founduser_not_foundcant_kick_selfnot_in_channelcant_kick_from_generalrestricted_actionnot_authedinvalid_authaccount_inactiveuser_is_bot

neededstringoptional

okbooleanrequired

Allowed:false

providedstringoptional

Error handling

channel must identify an existing conversation and user must identify the user to remove. The token must provide the conversations:write scope when supplied for authentication.

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.conversationsKick.create({
  channel: "example",
  user: "octocat",
});

{
  "ok": true
}

Request

Response

Errors