Skip to main content
POST
/
team
/
{team_id}
/
invite
Create a team invite
curl --request POST \
  --url https://api.basic.tech/team/{team_id}/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "roles": "<string>",
  "username": "<string>",
  "role_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "id": "<string>",
    "team_id": "<string>",
    "account_id": "<string>",
    "roles": "<string>",
    "role_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "email_or_username": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization Token header using the Bearer scheme

Path Parameters

team_id
string
required

The ID of the team to create an invite for

Body

application/json
email
string
required

The email of the account to invite to the team

roles
string
required

The roles assigned to the team member

username
string

The username of the account to invite to the team

role_name
string

Optional display name for the role

expires_at
string<date-time>

Optional expiration date for the invite

Response

Member invite created successfully

Member invite created successfully

data
object