Set Email Domain Allowlist (v2)

Use this REST API to set the allowed email domains to which emails can be sent from the EPM Cloud environment. If an email domain allowlist is set, emails will not be sent to any address whose domain is not one of the specified email domains.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/v2/mails/allowlist

Request

Supported Media Types: application/json

Table 2-183 Parameters

Name	Description	Type	Required	Default
alloweddomains	Comma-separated list of allowed email domains. To clear the allowlist, pass an empty string.	Payload	Yes	None

Sample Request Payload

The following payload specifies that emails should not be sent to any email address whose domain is not oracle.com or gmail.com.

{
  "alloweddomains": "oracle.com,gmail.com"
}

Sample Request Payload to Clear the Allowed Email Domain List and Allow any Email Domain

{
  "alloweddomains": ""
}

Response

Table 2-184 Parameters

Name	Description
details	In the case of errors, details are published with the error string
status	See Migration Status Codes
links	Detailed information about the link
href	Links to API call
action	The HTTP call type
rel	Possible values: self
data	Parameters as key value pairs passed in the request

Example of Response Body

{
    "details": null,
    "status": 0,
    "items": null,
    "links": [{
          "href": "https://<BASE-URL>/interop/rest/v2/mails/allowlist",
          "action": "POST",
          "rel": "self",
          "data": null
     }]
}

Sample cURL Command

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d  '{"alloweddomains":"example.com,oracle.com"}' 'https://<BASE-URL>/interop/rest/v2/mails/allowlist'