Skip to main content
POST
Create multiple invites

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
invites
object[]

Invites to create. Each entry follows the create-invite schema.

dryRun
boolean

A flag indicating whether the operation should be run in dry run mode (true) or not (false).

Response

Successfully fetched onboarding invites.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

code
string

Machine-readable result code. See the Error Codes reference.

message
string

Human-readable result message.

data
object

The response payload.

Last modified on July 14, 2026