Add User to Team

put/team/add_member

Invites a user (specified using the email_address parameter) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If a user is already a part of another Team, a team_invite_failed error will be returned.

Securityapi_key or oauth2
Request
query Parameters
team_id
string

The id of the team.

beta
Feature only available in closed beta. Contact us to request access.
Example: team_id=4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
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 of the user to invite to 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 user to invite to your Team.

role
string

A role member will take in a new Team.

Note: This parameter is used only if 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": "george@example.com"
}
Response samples
application/json
{
  • "team": {
    }
}