Skip to main content
POST
Invite Team Member

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

teamUuid
string<uuid>
required

UUID of the team.

Body

application/json
email
string<email>
required
Maximum string length: 255
name
string
required
Required string length: 2 - 255
role
enum<string>
required

Roles assignable via the API. owner is excluded; ownership is managed through a separate transfer flow.

Available options:
admin,
member,
viewer

Response

The invited member.

email
string<email>
required
name
string
required
role
enum<string>
required
Available options:
owner,
admin,
member,
viewer
status
enum<string>
required

pending until the member accepts their invitation.

Available options:
active,
pending