Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json

Teammate invitation details. Optional parameters (first_name, last_name, manager_id, group_ids) are only set when creating a new teammate, not when re-inviting.

email
string<email>
required

Email address of the teammate to invite

role
enum<string>
required

Role to assign to the teammate

Available options:
editor,
reviewer,
team_member
first_name
string

First name of the teammate (only set when creating a new teammate)

last_name
string

Last name of the teammate (only set when creating a new teammate)

manager_id
string

Manager identifier, which can be a UUID or an email using the format alt:email:<email> (only set when creating a new teammate)

group_ids
string<uuid>[]

List of teammate group IDs to add the teammate to (only set when creating a new teammate)

Response

Existing teammate was re-invited (use PATCH to update their properties)

data
object