See api-docs Menu

Update Email Settings Config

Use this API to update the Email Settings config.









Resource URL

https://<api-domain>/api/2/branding/email_settings

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Content-Type

required

string

Set to application/json.

Update Email Settings Event

When you update the Email Settings config, it produces an Event in the OneLogin admin portal. To view the event, in the admin portal go to ActivityEvents.

The event pictured below informs the admin that the operation succeeded.

Request Parameters

address string Required. Email Settings server address
domain string Required. Domain of the From address.
from string Required. The From email address in the message.
port integer Optional. Defaults to 2.5.
user_name string Optional. The user name of the account to authenticate with the Email Settings server.
password string Optional. The password of the account to authenticate with the Email Settings server.
use_tls boolean Optional. Defaults to true.

Sample Request Body

{
   "address": "smtp.sendgrid.net",
   "use_tls": true,
   "from": "email@example.com",
   "domain": "example.com",
   "user_name": "user-name",
   "password": "password",
   "port": 587
}

Sample Responses

{
   "message": "Settings Updated",
   "statusCode": 200,
   "name": "Success"
}

Typically, this error means that your Authorization header value is missing or incorrectly formatted. The Authorization header value should use this format: bearer:<access_token>.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Indicates that the syntax of the request is good but a value supplied is not valid.

{
    "message": "Validation failed",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Branding API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Update Email Settings Config

curl 'https://<api-domain>/api/2/branding/email_settings' \
-X PUT \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
    "address": ""smtp.sendgrid.net",
    "domain": "example.com",
    "from": "email@example.com"
}'

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.