Skip to content

Update Email Settings ​

Saves the sender, reply-to and footer for guest emails.

Endpoint ​

  • Method: POST
  • Path: /fluent-event/v2/settings/email
  • Controller: SettingsController@updateEmail
  • Route source: fluent-event/app/Http/Routes/api.php:29
  • Controller source: fluent-event/app/Http/Controllers/SettingsController.php:153

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 Settings​

POST
/settings/email

Saves the sender, reply-to and footer for guest emails.

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

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Request Body​

application/json
JSON
{
  
"from_email": "string",
  
"from_name": "string",
  
"reply_to_name": "string",
  
"reply_to_email": "string",
  
"email_footer": "string"
}

Responses​

Success

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"from_name": "string",
  
  
"from_email": "string",
  
  
"reply_to_name": "string",
  
  
"reply_to_email": "string",
  
  
"email_footer": "string"
  
}
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation