Skip to main content
POST
/
v1
/
invites
curl --request POST \
  --url https://api.caret.so/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "role": "member",
  "isUrlInvite": false
}'

{
  "invite": {
    "id": "inv_123",
    "email": "user@example.com",
    "code": "abc123xy",
    "role": "member",
    "expiresAt": "2026-02-27T10:00:00Z",
    "createdAt": "2026-01-28T10:00:00Z",
    "isUrlInvite": false
  }
}

​
Body

​
email
string
required
Email address of the person to invite.
​
role
string
default:"member"
Role to assign to the invitee. One of admin, member.
​
isUrlInvite
boolean
default:"false"
Whether to create a URL-based invite (true) or send an email invitation (false).

​
Response

​
invite
object
curl --request POST \
  --url https://api.caret.so/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "role": "member",
  "isUrlInvite": false
}'

{
  "invite": {
    "id": "inv_123",
    "email": "user@example.com",
    "code": "abc123xy",
    "role": "member",
    "expiresAt": "2026-02-27T10:00:00Z",
    "createdAt": "2026-01-28T10:00:00Z",
    "isUrlInvite": false
  }
}