Claude Platform Docs

Einladung erstellen

client.organization.invites.create(body, options?): OrganizationInvite
POST/v1/organizations/invites

Lädt einen Benutzer per E-Mail ein, der Organisation beizutreten.

Bei Plänen, deren Mitglieder aus einem begrenzten Kontingent gekaufter Plätze stammen, verbraucht die Einladung automatisch einen Platz aus der niedrigsten Stufe mit Verfügbarkeit; es gibt keinen Parameter für die Platzstufe. Wenn kein Platz frei ist, schlägt die Anfrage mit einem 400-Fehler fehl, anstatt einen Platz zu kaufen.

Parameters
body: InviteCreateParams { email; role; rbac_group_ids }
email: string

Email of the User.

formatemail
role: "billing" | "claude_code_user" | "developer" | 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.

One of the following:
"billing"
"claude_code_user"
"developer"
"managed"
"user"
rbac_group_ids?: Array<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
interface OrganizationInvite { type: "invite"; id; accepted_at; /* 6 more */ }
Einladung erstellen
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const organizationInvite = await client.organization.invites.create({
  email: "user@emaildomain.com",
  role: "user"
});

console.log(organizationInvite.id);
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"
}