Edit global email settings
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description |
|---|---|---|
| boolean | allow self-signed or otherwise invalid server certificates |
| string | type of connection to use to SMTP server (possible values: 'Plain', 'StartTLS' and 'TLS') |
| string | from email address for outgoing emails |
| string | password to use to authenticate to SMTP server |
| string | host name of SMTP server |
| integer | port number of SMTP server (non-negative) |
| string | username to use to authenticate to SMTP server |
{
"params": {
"allow_selfsigned_certs": false,
"encryption": "Plain",
"from_email": "string",
"password": "string",
"smtp_host": "string",
"smtp_port": 123,
"username": "string"
}
}
Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | global email settings |
| boolean | response with error or not |
email_settings
Property | Type | Description |
|---|---|---|
| boolean | allow self-signed or otherwise invalid server certificates |
| string | type of connection to use to SMTP server (possible values: 'Plain', 'StartTLS' and 'TLS') |
| string | from email address for outgoing emails |
| string | host name of SMTP server |
| integer | port number of SMTP server |
| string | username to use to authenticate to SMTP server |
error_response
Property | Type | Description |
|---|---|---|
| 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 |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}
Comments