Chat
Remove member from group
Remove participants from a group. This operation requires the connected phone to be an admin in the group.
Participants will only be removed if they are NOT the owner of the group.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token> is your apiKey
generated in Periskope API settings.
Headers
x-phone
string
requiredOrganisation phone number(with country code) and without any spaces or special characters.
e.g. 9190043XXXXX
Path Parameters
chat_id
string
requiredChat ID for which the action is to be performed
e.g.
For groups - 12054386805XXX@g.us
For individual chats - 9198765XXXXX@c.us
Body
application/json
participants
string[]
Array of Phone numbers (with country code) and without any spaces or special characters.
For e.g. 919876512340
Response
200 - application/json
{key}
object
Was this page helpful?