Skip to main content
POST
Invite Team User

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Body

application/json
email
string<email>
required
first_name
string
required
last_name
string
required
role
enum<string>
required
Available options:
team-admin,
team-member
job_title
string
tag_ids
string<uuid>[]
team_ids
string<uuid>[]

Organizational team UUID on the invitation. At most one team per person.

Maximum array length: 1
invited_by_member_id
string<uuid>

Team member profile UUID shown as email sender; defaults to first active team-admin.

invite_locale
enum<string>
Available options:
fr,
en

Response

Invitation created

data
object