Remove User from Team

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.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: teamRemoveMember
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

TeamRemoveMemberRequestrequired

Content-Type: application/json

Properties: account_idemail_addressnew_owner_email_addressnew_team_idnew_role

{
  "account_id": "example-account-id",
  "email_address": "developer@example.com",
  "new_owner_email_address": "developer@example.com",
  "new_team_id": "example-new-team-id",
  "new_role": "Member"
}

Responses

`201`

TeamGetResponseapplication/json

successful operation

Properties: teamwarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "team": {
    "name": "Example Name",
    "accounts": [
      {
        "account_id": "example-account-id",
        "email_address": "developer@example.com",
        "is_locked": false,
        "is_paid_hs": false,
        "is_paid_hf": false,
        "quotas": {
          "api_signature_requests_left": 0,
          "documents_left": 0,
          "templates_total": 0,
          "templates_left": 0,
          "sms_verifications_left": 0,
          "num_fax_pages_left": 0
        },
        "callback_url": "https://example.com/resource"
      }
    ],
    "invited_accounts": [
      {
        "account_id": "example-account-id",
        "email_address": "developer@example.com",
        "is_locked": false,
        "is_paid_hs": false,
        "is_paid_hf": false,
        "quotas": {
          "api_signature_requests_left": 0,
          "documents_left": 0,
          "templates_total": 0,
          "templates_left": 0,
          "sms_verifications_left": 0,
          "num_fax_pages_left": 0
        },
        "callback_url": "https://example.com/resource"
      }
    ],
    "invited_emails": [
      "developer@example.com"
    ]
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}