groups/members/remove

POST https://api.dropboxapi.com/2/team/groups/members/remove

groups/members/remove

scope: groups.write

Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed. This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management.

Request Body

{"group"=>{".tag"=>"group_id", "group_id"=>"g:e2db7665347abcd600000000001a2b3c"}, "users"=>[{".tag"=>"team_member_id", "team_member_id"=>"dbmid:efgh5678"}], "return_members"=>true}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"group_info":{"group_name":"project launch","group_id":"g:e2db7665347abcd600000000001a2b3c","group_management_type":{".tag":"user_managed"},"created":1447255518000,"member_count":5,"members":[{"profile":{"team_member_id":"dbmid:1234567","email":"mary@lamb.com","email_verified":true,"status":{".tag":"active"},"name":{"given_name":"Franz","surname":"Ferdinand","familiar_name":"Franz","display_name":"Franz Ferdinand (Personal)","abbreviated_name":"FF"},"membership_type":{".tag":"full"},"account_id":"dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc","secondary_emails":[{"email":"apple@orange.com","is_verified":true},{"email":"banana@honeydew.com","is_verified":true},{"email":"grape@strawberry.com","is_verified":false}],"joined_on":"2015-05-12T15:50:38Z","profile_photo_url":"https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"},"access_type":{".tag":"member"}}]},"async_job_id":"99988877733388"}