Remove participants from a Call | Sample

1 parameter · 2 body fields

tokenstringrequired

Authentication token with the `calls:write` scope.

The Call participant removal details.

idstringrequired

`id` returned by the [`calls.add`](/methods/calls.add) method.

usersstringrequired

The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).

2 status codes

200Returns a success response containing `ok: true`.

okbooleanrequired

Allowed:true

defaultReturns a failure response containing `ok: false` and an error reason.

okbooleanrequired

Allowed:false

Error handling

id and users are required. Use the id returned by calls.add and format users according to the Call participant specification.

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.callsParticipantsRemove.create({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  users: "example",
});

{
  "ok": true
}

Request

Response

Errors