members/remove
POST https://api.dropboxapi.com/2/team/members/remove
scope: members.delete
Removes a member from a team.
Permission : Team member management
Exactly one of teammemberid, email, or externalid must be provided to identify the user account.
Accounts can be recovered via members/recover
for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling members/add
while a user is still recoverable on your team will return with `MemberAddResult.useralreadyonteam.
Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).
This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll
members/remove/job_status/get`.
Request Body
{"user"=>{".tag"=>"team_member_id", "team_member_id"=>"dbmid:efgh5678"}, "wipe_data"=>true, "transfer_dest_id"=>{".tag"=>"team_member_id", "team_member_id"=>"dbmid:efgh5678"}, "transfer_admin_id"=>{".tag"=>"team_member_id", "team_member_id"=>"dbmid:efgh5678"}, "keep_account"=>false, "retain_team_shares"=>false}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{".tag":"complete"}