Skip to main content
POST
Invite someone to a team

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

teamID
string
required

The team's ID. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
email
string<email>
required
roleID
string
required

ID of the role the person gets when they join. See GET /v2/teams/{teamID}/roles.

Pattern: ^[0-9a-fA-F]{24}$

Response

The invitation was sent.

Link the invited person opens to accept.