Dispatches an email using the provided email configuration.

post

https://localhost:44395/api/admin/system/email-dispatcher

Behavior: Processes and sends an email based on the provided EmailDispatcherModel configuration. Only admin users are permitted to dispatch emails.

Authorization: Requires an authenticated user via the [Authorize] attribute. Additionally, the user must be an admin (checked via IsAdminUser).

Side Effects: Sends an email to the recipients specified in the input model.

Error Scenarios: Returns 400 if the input model is null or invalid. Throws a VibrantException if the current user is not an admin.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The EmailDispatcherModel input containing email configuration such as recipients, subject, and body.

Represents an email dispatch request containing recipient details, email type, and contextual data.

uuid

Gets or sets the unique identifier of the email dispatch request.

emailType

string

enum

AssetRestored

UserApproved

CollectionShared

CollectionSharedExternal

UserInvite

AssetShared

DownloadZipFile

MediaBuilderNotification

LiveRecordingStopped

ExportSearchResults

AssetSharedExternal

userId

uuid

Gets or sets the identifier of the user associated with the email.

assetId

uuid

Gets or sets the identifier of the asset referenced in the email.

userFirstName

string | null

Gets or sets the first name of the user for email personalization.

userLastName

string | null

Gets or sets the last name of the user for email personalization.

userEmail

string | null

Gets or sets the email address of the user.

assetName

string | null

Gets or sets the name of the asset referenced in the email.

recipients

array of strings | null

Gets or sets the list of recipient email addresses.

recipients

properties

object | null

Gets or sets additional dynamic properties used for email template rendering.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized. The caller must provide a valid Bearer token.

200Email dispatched successfully.

400The input model is null or the user lacks admin permissions.