Clear global email settings

Request

HTTP Method: POST
Content Type: application/json

Parameters

None.

{
    "params": {}
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`result`	object of type `email_settings`	global email settings
`successful`	boolean	response with error or not

email_settings

Property	Type	Description
`allow_selfsigned_certs`	boolean	allow self-signed or otherwise invalid server certificates
`encryption`	string	type of connection to use to SMTP server (possible values: 'Plain', 'StartTLS' and 'TLS')
`from_email`	string	from email address for outgoing emails
`smtp_host`	string	host name of SMTP server
`smtp_port`	integer	port number of SMTP server
`username`	string	username to use to authenticate to SMTP server

error_response

Property	Type	Description
`message`	string	error message

{
    "error": {
        "message": "string"
    },
    "result": {
        "allow_selfsigned_certs": false,
        "encryption": "Plain",
        "from_email": "string",
        "smtp_host": "string",
        "smtp_port": 123,
        "username": "string"
    },
    "successful": true
}

HTTP Status: 400

Content Type: application/json

Response

Property	Type	Description
`error`	object of type `error_response`	error response
`successful`	boolean	always false

error_response

Property	Type	Description
`message`	string	error message

{
    "error": {
        "message": "string"
    },
    "successful": false
}

We're here to help!

/email-settings/clear

Request

Parameters

Response

HTTP Status: 200

Response

HTTP Status: 400

Response

Comments