API ReferenceTeam

Remove User from Team

View as Markdown
Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
account_idstringOptional

account_id or email_address is required. If both are provided, the account id prevails.

Account id to remove from your Team.

email_addressstringOptionalformat: "email"

account_id or email_address is required. If both are provided, the account id prevails.

Email address of the Account to remove from your Team.

new_owner_email_addressstringOptionalformat: "email"

The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.

NOTE: Only available for Enterprise plans.

new_team_idstringOptional
Id of the new Team.
new_roleenumOptional

A new role member will take in a new Team.

NOTE: This parameter is used only if new_team_id is provided.

Allowed values:

Response headers

X-RateLimit-Limitinteger
The maximum number of requests per hour that you can make.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-Ratelimit-Resetinteger
The Unix time at which the rate limit will reset to its maximum.

Response

successful operation
teamobject
Contains information about your team and its members
warningslist of objects
A list of warnings.

Errors

4XX
Client Request Error