招待作成 - Caret

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

POST

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

string

必須

招待する人のメールアドレス。

string

デフォルト:"member"

招待された人に割り当てる役割。admin、memberのいずれか。

boolean

デフォルト:"false"

URL招待を作成するか（true）、メール招待を送信するか（false）。

レスポンス

object

表示 Invite

string

招待の一意識別子。

string

招待された人のメールアドレス。

string

招待コード。

string

招待された人に割り当てられた役割。

string

招待が期限切れになるISO8601タイムスタンプ。

string

招待が作成されたISO8601タイムスタンプ。

boolean

URL招待かどうか。

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

⌘I

​Body

​レスポンス

Body

レスポンス