SPA Mail Server Configurations

SPA: Create mail server configuration

Creates a new mail server configuration for the client.

POST/api/spa/mail-server-configurations

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json
required

The new MailServerConfiguration resource

{
  "identifier": "string",
  "dsn": "string",
  "sender": "string",
  "headers": [
    "string"
  ],
  "subClient": {},
  "active": true,
  "activeFrom": "2024-01-01",
  "subClientDefault": false
}

Response

201application/json

MailServerConfiguration resource created

id
integer
identifier
stringrequired
dsn
stringrequired
sender
string<email>required
headers
string[]required
createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

subClientDefault
boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"