Skip to main content

Send an email from a template

PUT 

/api/v1/Email

Builds an email from an email template for one user and queues it for delivery. Each key in the request body is a text placeholder in the template that is replaced with its value. The call fails if the user has no email address or the template is empty.

Permission required: Admin role (or the App role).

Values for importance: 0 = Low, 1 = Normal, 2 = High.

Values for priority: 0 = NonUrgent, 1 = Normal, 2 = Urgent.

Caution: The call queues a real email to the user right away.

Request​

Responses​

The email was queued. The body is the queued email.