BackendService

Create User Invite

Create a User Invite.

post/v1/user-invites

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

Changes

Changed in 4 of the 10 revisions of this API.5143

May 13, 202518208de692431See the full diff
- ○
  added the new optional query request parameter sendEmail
  new-optional-request-parameter
Mar 11, 2025e3ac0347dfbe161See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
Mar 5, 2025aae16339e1e148See the full diff
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2025b9fc18a0eac31See the full diff
- ○
  endpoint added
  endpoint-added

Full history