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

NameTypeRequiredDescription
tokenStringYesAuthentication token of the user
channelIdStringYesId of the channel
membersArrayYesAn 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.

{
    "members": {
        "u:<id1>": { "status": "removed" },
        "u:<id2>": { "status": "failed", "error": "UserNotFound" }
    }
}