Claude Platform Docs

Buat Undangan

POST/v1/organizations/invites

Undang pengguna untuk bergabung dengan organisasi melalui email.

Pada paket yang mengambil anggota dari kumpulan kursi terbatas yang dibeli, undangan secara otomatis menggunakan satu kursi dari tingkat terendah yang masih tersedia; tidak ada parameter tingkat kursi. Jika tidak ada kursi yang tersedia, permintaan gagal dengan error 400 alih-alih membeli kursi.

Headers
"anthropic-version": optional string

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Body
email: string

Email of the User.

formatemail
role: "billing" or "claude_code_user" or "developer" or 2 more

Role for the invited User.

The accepted values depend on the organization type. Console and API organizations accept user, developer, billing, and claude_code_user; admin cannot be assigned through the API. Claude Enterprise organizations accept user and managed; inviting with the managed role requires the write:rbac_groups scope in addition to write:members.

One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
rbac_group_ids: optional array of string

RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the write:rbac_groups scope.

maxItems100
Returns
BetaOrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
Buat Undangan
curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "email": "user@emaildomain.com",
          "role": "user"
        }'
Returns Examples
Response 200
{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "accepted_at": "2019-12-27T18:11:19.117Z",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "rbac_group_ids": [
    "string"
  ],
  "role": "admin",
  "status": "pending",
  "type": "invite"
}