Skip to main content
POST
/
v1
/
teams
/
{team_id}
/
invites
Invite Users
curl --request POST \
  --url https://api.example.com/v1/teams/{team_id}/invites \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "invited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "OWNER",
  "status": "PENDING",
  "created_at": 123,
  "expires_at": 123
}

Path Parameters

​
team_id
string<uuid>
required

Body

application/json

Request model for inviting a user to a team (team_id comes from path).

​
email
string
required

Email address of the user to invite

Minimum string length: 1
​
role
enum<string>
default:MEMBER

Role to assign to the invited user

Available options:
OWNER,
ADMIN,
MEMBER

Response

Successful Response

Team invitation domains model.

​
id
string<uuid>
required
​
team_id
string<uuid>
required
​
email
string
required
​
invited_by
string<uuid>
required
​
role
enum<string>
required

Team membership roles.

Available options:
OWNER,
ADMIN,
MEMBER
​
status
enum<string>
required

Invitation status.

Available options:
PENDING,
ACCEPTED,
DECLINED,
EXPIRED
​
created_at
integer
required
​
expires_at
integer
required
Last modified on April 21, 2026