POST /2/team/members/remove
members/remove
scope: members.delete
Removes a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id 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.user_already_on_team.
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.
Servers
- https://api.dropboxapi.com
- https://content.dropboxapi.com
- https://notify.dropboxapi.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
keep_account |
Boolean | No | |
retain_team_shares |
Boolean | No | |
transfer_admin_id |
Object | No | |
transfer_admin_id.team_member_id |
String | No | |
transfer_admin_id..tag |
String | No | |
user |
Object | No | |
user.team_member_id |
String | No | |
user..tag |
String | No | |
transfer_dest_id |
Object | No | |
transfer_dest_id.team_member_id |
String | No | |
transfer_dest_id..tag |
String | No | |
wipe_data |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.