Create the email settings

POST 
/api/v1/Email/settings

Creates the email settings record if it does not exist yet. The record is created with default values and the values in the request body are not applied, so call the update route afterward to set the mail server details.

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

Caution: The call fails once the email settings exist. If a create call reports an error, the record may still have been created, so check with the get route before you retry.

Request

Responses

201

The settings record was created. The body is the new record.

400

The email settings already exist ("Only one email service allowed.") or the record could not be created. The body is an error message.

403

The signed-in user does not have the required role, or the account has read-only access.

500

The server failed while building the response. The settings record may still have been created, so check with the get route before you retry.