Sign in
latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

beta.admin.users

Invite Users

Invite users to the Organization.

post/v1/admin/users-invite

Request body

role_namesstring[] nullable

Simplified role names to assign. Mutually exclusive with 'roles'.

role_name'member' | 'billing_manager' | 'organization_admin' nullable

Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'.

emailstring required

Email address, comma-separated emails, or newline-separated emails to invite.

subscription_type'API' | 'CHAT' | 'ON_PREMISE' | 'LICENSE' | 'MISTRAL_CODE'
subscription_typesPlanType[] nullable

Product seats to assign to invited users.

subscription_seat_automatic_grantingboolean

Whether to grant subscription seats automatically.

email_language'en' | 'fr' | 'es' | 'de' | 'it' | 'pt_br' | 'pl' | 'ar' | 'nl' nullable

Language used for invitation emails.

workspace_uuidsstring[] nullable

Workspace IDs the invited users should join.

Example request

{
  "email": "alice.martin@example.com, bob.smith@example.com"
}

Response

OK

invalid_emailsstring[] required

Email addresses that could not be invited.

already_membersstring[] required

Email addresses that already belong to the Organization.

invited_members_countinteger nullable

Number of invitations successfully created.