See api-docs Menu

Reset Email Settings Config

Use this API to reset the Email Settings Config.

Be careful, this operation is final and can’t be undone.





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 Manage All.

Reset Email Settings Event

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

Sample Responses

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

Typically, this error means that your Authorization header value is missing or incorrectly formatted.

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

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.

Delete Email Settings Config

curl 'https://<api-domain>/api/2/branding/email_settings' \
-X DELETE \
-H "Authorization: bearer <access_token>"

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.