Claude Platform Docs

Criar convite

POST/v1/organizations/invites

Convide um usuário para ingressar na organização por e-mail.

Em planos que obtêm membros de um conjunto finito de assentos comprados, o convite consome automaticamente um assento do nível mais baixo com disponibilidade; não há parâmetro de nível de assento. Quando não há assento livre, a solicitação falha com um erro 400 em vez de comprar um assento.

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.

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
Invite object{ id, accepted_at, email, 6 more }
Criar convite
cURL
curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN" \
    -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": "user",
  "status": "pending",
  "type": "invite"
}