Create User Invite

Create a User Invite.

Query parameters

sendEmailbooleanOptional
Whether to send an email automatically as part of the invite.

Request

This endpoint expects an object.
idstringOptional

The User Invite ID. Starts with user_invite_....

organizationIdstringOptional
The Organization this User Invite belongs to.
createTimestringOptionalformat: "date-time"
When the User Invite was created.
updateTimestringOptionalformat: "date-time"
When the User Invite was last updated.
emailstringOptional
The invitee's email address.
ownerbooleanOptional
Indicates whether the invited User will have owner privileges in the Organization.

Response

OK
userInviteobject
The created User Invite.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error