- URL:
- https://<root>/system/emailSettings/delete
- Methods:
POST- Version Introduced:
- 10.8.1
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The delete operation deletes an organization's email settings. Once deleted, administrative contacts will no longer receive email notifications about password policy changes and license expirations, and members with built-in accounts will no longer be able to use their email to retrieve forgotten passwords.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the delete operation:
POST /<context>/portaladmin/system/emailSettings/delete HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}