Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
chats
group

Remove Participant from Group

This endpoint removes a participant from a group

post/chats/{chat_id}/remove

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

participantsstring[] required
  • Provide a list of participants to be removed from the group (in country_code + number format).

Example request

{
  "participants": [
    "919537851844"
  ]
}

Response

200 OK

object required

The response is an object with is_success value for each participant