Remove User from Team

post/team/remove_member

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.

Securityapi_key or oauth2
Request
Request Body schema: application/json
account_id
string

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

Account id to remove from your Team.

email_address
string <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_address
string <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_id
string

Id of the new Team.

beta
Feature only available in closed beta. Contact us to request access.
new_role
string

A new role member will take in a new Team.

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

beta
Feature only available in closed beta. Contact us to request access.
Enum: "Member" "Developer" "Team Manager" "Admin"
Responses
200

successful operation

4XX

failed_operation

Request samples
application/json
{
  • "email_address": "teammate@hellosign.com",
  • "new_owner_email_address": "new_teammate@hellosign.com"
}
Response samples
application/json
{
  • "team": {
    }
}