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.

createTimedatetimeOptional

When the User Invite was created.

updateTimedatetimeOptional

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

userInviteobjectOptional

The created User Invite.

Errors