Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Users

Invite user

Invites a new user to the organization with specified role and organization.

post/iam/v1/users/invite

Request body

emailstring email required

The email address of the user.

firstNamestring

The first name of the user being invited.

lastNamestring

The last name of the user being invited.

jobTitle'Data Engineer / Data Analysts' | 'Executive Team' | 'Finance / Accounting' | 'Founder' | 'Legal / Purchasing' | 'Management' | 'Sales / Marketing' | 'Software / Ops Engineer'

The job function of the user being invited.

roleIdstring

The ID of the role to assign to the user.

organizationIdstring

The ID of the organization to assign the user to.

Response

Created - User invitation created successfully.

messagestring

Success message