Edit me

Commands

* Validation error text may vary depending on a source of an error

Description

This method is for removing a user or a service from group dialog.

On succes empty response with http code 200 is returned.

Endpoint

https://messapi.btsdapps.net/bot/v1/updates/

Structure

Variable Obligative Type Validation Description
type true String Must be filled with “KickFromGroup” value Type of request “KickFromGroup”
groupId true String groupId must be a valid UUID String for specifying ID of group dialog to remove a member from
peerToKick true Peer For Peer type validation see type page Peer to be removed from group

Sample request

{  
   "commands":[  
      {  
         "type":"KickFromGroup",
         "groupId":"Uuid_value",
         "peerToKick":{  
            "type":"USER",
            "id":"Uuid_value"
         }
      }
   ]
}

Updates

This method may asynchronously return following updates:

N/A

Possible business exceptions

Common context

  • Removing a peer (user/service) from group isn't available if a group dialog wasn't found (deleted/ID error);
  • Removing a peer (user/service) from group isn't available if peer wasn't found in group dialog (peer has already exited/been removed/ID error);
  • Removing a peer (user/service) from group isn't available if peer is a group owner or admin;
  • Removing a peer (user/service) from group isn't available if service isn't a group owner and admin with permission to delete ;