This method allows removing members from a given channel. The user removing the members must be a member of the channel and must have permission to modify the member list.
The method endpoint is https://api.flock.co/v1/channels.removeMembers and follows the method calling conventions.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | Yes | Authentication token of the user |
channelId | String | Yes | Id of the channel |
members | Array | Yes | An array of user ids that will be removed from the channel |
Response
An object where the keys are user ids of members that were removed and the values are ChannelMemberStatus objects, indicating whether the members were successfully removed or not.
Example
{
"members": {
"u:<id1>": { "status": "removed" },
"u:<id2>": { "status": "failed", "error": "UserNotFound" }
}
}