Users

Invite user

Invites a new user. Sets status to "invited" and triggers an invitation email. Creates an actor record server-side.

post/users

Request

Base URL
https://api.voltairlabs.com
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/voltairlabs/apis/voltair-api/docs/users/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring uuid

Idempotency key for POST requests. If a transaction with the same key already exists for the org, the server returns the original response without re-executing. Keys are valid for 48 hours.

Request body

firstNamestring required

lastNamestring required

emailstring required

roleIdstring uuid required

phonestring

Response

Created

transactionIdstring uuid required

Changes

No recorded changes to this operation across all 5 revisions of this API.