Remove from a Group
This removes a participant from a group from which the Ongair hosted account is an administrator.
Url:
https://ongair.im/api/v1/base/groups/{id}/remove_participant
Method:
POST
Params:
| Field | Type | Mandatory | Format | Meaning |
|---|---|---|---|---|
| id | Integer | Yes | Utf8 only encoded strings | The group id as returned from the group created call |
| phone_number | String | Yes | (country code)(phone number) e.g. 254722200200 | The contact phone number |
Response:
The server responds with a JSON message:
{"removed": true }
Error:
If there is an error, the server returns an error message and response code of 422.
{"error":"Contact with the phone number ‘254722200200’ is not a member of the group"}