BackendService

Create User Invite

Changed on

Create a User Invite.

post/v1/user-invites

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

sendEmailboolean

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

Request body

idstring

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

organizationIdstring

The Organization this User Invite belongs to.

createTimestring date-time

When the User Invite was created.

updateTimestring date-time

When the User Invite was last updated.

emailstring

The invitee's email address.

ownerboolean

Indicates whether the invited User will have owner privileges in the Organization.

Response

OK

Changes

    • info

      added the new optional query request parameter sendEmail

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status