/calls.participants.remove

POST

Registers participants removed from a Call.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/calls.participants.remove' \
--header 'token;' \
--data-urlencode 'id=' \
--data-urlencode 'users='

Response Example

200 - response

{
    "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: calls:write

Body Params application/x-www-form-urlencoded

string

required

id returned by the calls.add method.

users

string

required

The list of users to remove as participants in the Call. Read more on how to specify users here.

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

Modified at 2023-08-15 05:39:45

/calls.participants.add

/chat.delete