Skip to content

Update Email Notification Settings ​

Turns the confirmation, cancellation and reminder emails on or off, and sets up to five reminder times.

Each reminder time must be a whole number from 5 minutes to 30 days before the event. FluentEvent stores only the keys listed below and drops any other key in the body. Saving requeues the reminders of every upcoming event in the background.

Endpoint ​

  • Method: POST
  • Path: /fluent-event/v2/settings/email-notifications
  • Controller: SettingsController@updateEmailNotifications
  • Route source: fluent-event/app/Http/Routes/api.php:32
  • Controller source: fluent-event/app/Http/Controllers/SettingsController.php:176

Permissions ​

  • Requires the manage_options capability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.

Hooks Fired ​

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.

Update Email Notification Settings​

POST
/settings/email-notifications

Turns the confirmation, cancellation and reminder emails on or off, and sets up to five reminder times.

Controller: SettingsController@updateEmailNotifications
Route source: fluent-event/app/Http/Routes/api.php:32

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Request Body​

application/json
JSON
{
  
"registration_confirmation": [
  
],
  
"registration_cancellation": [
  
],
  
"reminder_to_guest": [
  
  
{
  
  
  
"enabled": true,
  
  
  
"times": [
  
  
  
  
{
  
  
  
  
  
"unit": "string",
  
  
  
  
  
"value": 0
  
  
  
  
}
  
  
  
]
  
  
}
  
]
}

Responses​

Success

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"registration_confirmation": {
  
  
  
"enabled": true
  
  
},
  
  
"registration_cancellation": {
  
  
  
"enabled": true
  
  
},
  
  
"reminder_to_guest": {
  
  
  
"enabled": true,
  
  
  
"times": [
  
  
  
  
{
  
  
  
  
  
"value": 0,
  
  
  
  
  
"unit": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation