Bulk invite up to 50 users
POST/users/bulk-invite
Invites up to 50 users in a single request. Each item is processed independently. Partial failures do not roll back successful items — check per-item status in the response. Errors for individual items are included in the results array, not as HTTP errors.
Request
Header Parameters
Optional idempotency key (24 h cache). Repeat calls with the same key and path return the cached response.
Body
required
Array [
]
invites
object[]
required
Possible values: >= 1, <= 50
Up to 50 invite items per request.
bob@example.comPossible values: non-empty
Bob JonesdeveloperexternalRef
object
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
metadata
object
Send invitation emails for all items. Default false for bulk.
falseOK
Schema
Array [
]
results
object[]
required
Possible values: [invited, existing, linked, error]
91