Save the SMTP settings

POST /api/2.0/smtpsettings/smtp

Request

Saves the SMTP settings for the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

SMTP settings

hoststring

Host

portintegerformat: int32

Port

senderAddressstring

Sender address

senderDisplayNamestring

Sender display name

credentialsUserNamestring

Credentials username

credentialsUserPasswordstring

Credentials user password

enableSSLboolean

Enables SSL or not

enableAuthboolean

Enables authentication or not

useNtlmboolean

Specifies whether to use NTLM or not

isDefaultSettingsboolean

Specifies if the current settings are default or not

Examples

POST /api/2.0/smtpsettings/smtp HTTP/1.1
Accept: application/json
Content-Length: 233
Content-Type: application/json
Host: example.com

{
  "host": "mail.example.com",
  "port": 25,
  "senderAddress": "notify@example.com",
  "senderDisplayName": "Postman",
  "credentialsUserName": "notify@example.com",
  "credentialsUserPassword": "{password}",
  "enableAuth": true
}

curl --request POST \
  --url https://example.com/api/2.0/smtpsettings/smtp \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "host": "mail.example.com",
  "port": 25,
  "senderAddress": "notify@example.com",
  "senderDisplayName": "Postman",
  "credentialsUserName": "notify@example.com",
  "credentialsUserPassword": "{password}",
  "enableAuth": true
}'

Responses

200

SMTP settings

SMTP settings

hoststring

Host

portintegerformat: int32

Port

senderAddressstring

Sender address

senderDisplayNamestring

Sender display name

credentialsUserNamestring

Credentials username

credentialsUserPasswordstring

Credentials user password

enableSSLboolean

Enables SSL or not

enableAuthboolean

Enables authentication or not

useNtlmboolean

Specifies whether to use NTLM or not

isDefaultSettingsboolean

Specifies if the current settings are default or not

401

Unauthorized

403

Forbidden