Claude Platform Docs

Convites

Criar convite
POST/v1/organizations/invites

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

Listar convites
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

Models
AlreadyMemberErrorDetails object{ error_code }

The email address already belongs to a user in the organization. The message names the user.

error_code: "already_member"
CannotInviteEmailsWithUnverifiedDomainsErrorDetails object{ error_code }

The email address's domain is not one of the verified domains of the organization's parent organization.

error_code: "cannot_invite_emails_with_unverified_domains"
EmailDomainNotAllowedErrorDetails object{ error_code }

The organization restricts invites to an allowed list of email domains, and the list is empty or does not include the email address's domain.

error_code: "email_domain_not_allowed"
InviteAlreadyExistsErrorDetails object{ error_code }

A pending invite already exists for the email address. The message names the invite.

error_code: "invite_already_exists"
OrganizationInvite object{ type: "invite", id, accepted_at, 6 more }
InviteDeleteResponse object{ type: "invite_deleted", id }
type: "invite_deleted"

Deleted object type.

For Invites, this is always "invite_deleted".

defaultinvite_deleted
id: string

ID of the Invite.