Preview Email
Renders a guest email with sample data, so the settings screen can show it.
Uses a sample online event that starts in 7 days and a sample guest. Nothing is sent.
Endpoint
- Method:
GET - Path:
/fluent-event/v2/settings/email-notifications/preview/{type} - Controller:
SettingsController@previewEmail - Route source:
fluent-event/app/Http/Routes/api.php:33 - Controller source:
fluent-event/app/Http/Controllers/SettingsController.php:193
Permissions
- Requires the
manage_optionscapability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.
Live sample
The request and response below were recorded on a running FluentEvent site and then anonymised. Names, emails and event titles are fictional, and long lists are cut to a few items.
Preview Email
GET
/settings/email-notifications/preview/{type}
Renders a guest email with sample data, so the settings screen can show it.
Controller: SettingsController@previewEmail
Route source: fluent-event/app/Http/Routes/api.php:33
Authorizations
ApplicationPasswords
A WordPress username and an Application Password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Which email to render.
Type
Requiredstring
Pattern
"^[A-Za-z0-9_-]+$"Responses
Success
application/json
JSON "subject": "string", "html": "string"
{
}