Skip to content

Get Email Notification Settings ​

Returns which guest emails are on, and when reminders go out.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/settings/email-notifications
  • Controller: SettingsController@getEmailNotifications
  • Route source: fluent-event/app/Http/Routes/api.php:31
  • Controller source: fluent-event/app/Http/Controllers/SettingsController.php:169

Permissions ​

  • Requires the manage_options capability (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.

Get Email Notification Settings​

GET
/settings/email-notifications

Returns which guest emails are on, and when reminders go out.

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

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Responses​

Success

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

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation