1. Docs
2. Reference
3. REST API Docs
4. Schema
5. BatchCreateOrganizationInviteRequest

Request body for batch create organization invite.

Properties

• invites array[CreateOrganizationInviteRequest] required
  List of invites
• ↳ email string optional
  The email address. Required for email-based invites, omitted when creating shareable invite links.
• ↳ role enum required
  Built-in role to assign to the invited member. When ‘roleId’ is also supplied it takes precedence and this field is ignored. Use ‘member’, ‘admin’ or ‘billing-manager’, or ‘reader’, ‘builder’ or ‘maintainer’ in an organization with a default role. ‘member’ puts the invited member on the default role, while ‘reader’, ‘builder’ and ‘maintainer’ assign that role explicitly.
  Values:

  member — Member

  Regular organization member.

  admin — Admin

  Organization administrator.

  billing-manager — BillingManager

  Billing administrator.

  reader — Reader

  Reader role. Available only in organizations with a default role.

  builder — Builder

  Builder role. Available only in organizations with a default role.

  maintainer — Maintainer

  Maintainer role. Available only in organizations with a default role.

• ↳ roleId string optional
  UUID of a role (built-in or custom) to assign to the invited member. Takes precedence over ‘role’ when both are supplied.
• token string optional
  Turnstile token