메인 콘텐츠로 건너뛰기
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
필수
초대할 사람의 이메일 주소.
role
string
기본값:"member"
초대받는 사람에게 할당할 역할. admin, member 중 하나.
isUrlInvite
boolean
기본값:"false"
URL 기반 초대를 생성할지(true) 이메일 초대를 보낼지(false) 여부.

응답

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
  }
}