Invite one or more users as guests with access to specific content.

post

https://localhost:44395/api/account/invite-user

Behavior: Sends guest invitations to the specified email addresses, granting them access to the specified content. For each email: if the user does not already exist, a new guest account is created with PendingInvitation status and an expiration date based on the guest profile settings. An invitation email is sent to each recipient with instructions to complete their registration.

Authorization: Requires a valid Bearer token (class-level [Authorize]).

Side Effects: Creates guest user accounts with PendingInvitation status. Grants content access permissions. Sends invitation emails to each specified email address.

Error Scenarios: Returns 400 if the request is null, Emails array is empty, or ContentDefinitionId is missing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A Nomad.Common.Models.UserInviteRequestModel containing the Emails to invite, ContentDefinitionId for the content to share, and optional ContentId for specific content.

Request model for inviting or removing guest users with content access.

contentId

uuid | null

Gets or sets the identifier of the specific content item to grant or revoke access to.

contentDefinitionId

uuid | null

Gets or sets the content definition identifier that defines the type of content being shared. Required when inviting users.

userId

uuid | null

Gets or sets the unique identifier of a specific user to invite or remove. Provide either UserId or Emails.

emails

array of strings | null

Gets or sets the array of email addresses to invite or remove. Provide either Emails or UserId.

emails

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200

All invitations were sent successfully.

401

The caller is not authenticated.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400The request is null, Emails is empty, or ContentDefinitionId is missing.