Skip to main content
POST
/
api
/
v1
/
teams
/
{team_id}
/
members
/
invite
Invite Team Member
curl --request POST \
  --url https://api.example.com/api/v1/teams/{team_id}/members/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "standard"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "invited_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string<uuid>
required

Body

application/json
email
string<email>
required

Email of the person to invite

role
enum<string>
default:standard

Role to grant on acceptance

Available options:
admin,
standard

Response

Successful Response

id
string<uuid>
required
email
string
required
role
string
required
status
string
required
created_at
string<date-time>
required
invited_by_user_id
string<uuid> | null
expires_at
string<date-time> | null