English ← MyDocs

创建邀请

post /v1/organizations/invites

创建邀请

请求体参数

  • email: string

    用户的邮箱地址。

  • role: "user" or "developer" or "billing" or "claude_code_user"

    被邀请用户的角色。不能为 "admin"。

    • "user"

    • "developer"

    • "billing"

    • "claude_code_user"

返回值

  • Invite object { id, email, expires_at, 4 more }

    • id: string

      邀请的 ID。

    • email: string

      被邀请用户的邮箱地址。

    • expires_at: string

      RFC 3339 日期时间字符串,表示邀请的过期时间。

    • invited_at: string

      RFC 3339 日期时间字符串,表示邀请的创建时间。

    • role: "user" or "developer" or "billing" or 2 more

      用户在组织中的角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      邀请的状态。

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      对象类型。

      对于邀请,始终为 "invite"

      • "invite"

示例

curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "email": "user@emaildomain.com",
          "role": "user"
        }'

响应

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}