Knowledge Center

Knowledge Center > Reporting > API Reference > Additional Operations > Update Tenant Settings

Update Tenant Settings

Contact Zuora Global Support to enable this feature in your tenant. This feature is currently in development and is subject to change without advance notice.

The Update Tenant Settings Reporting API posts a JSON formatted name value pair of email domains that will be allowed as recipients of scheduled report results.  Once a domain or set of domains are set as allowed email domains then report schedules can not be saved and run if any email recipient address does not match the specified mask.

Posting an update to the tenant settings overrides any previous email domain setting for the tenant.

Request

Environment Request
API Sandbox (US Data Center) POST https://zconnectsandbox.zuora.com/api/rest/v1/settings 
Production (US Data Center) POST https://zconnect.zuora.com/api/rest/v1/settings
API Sandbox (EU Data Center) POST https://zconnect.sandbox.eu.zuora.com/api/rest/v1/settings
Production (EU Data Center) POST https://zconnect.eu.zuora.com/api/rest/v1/settings

Request POST Body

The request post body is a very simple JSON pair.  One or more values can be submitted alone or as a comma separated list that takes the following form:

{
  "emailDomains" : [ "CorporationXYZ.com""zuora.com" ]

}

Posting the following request body would remove any defined domain mask.

{
  "emailDomains" : []
}

Example

HTTPS Request

POST https://zconnectsandbox.zuora.com/api/rest/v1/settings

 

JSON Response

{
  "success" : true,
  "response" : {
    "status" : "OK",
    "code" : 100,
    "message" : "Success"
  }
}

Exceptions

Exception Condition
Bad Request The API endpoint is likely malformed.  Check the API URL request name space.
Last modified

Tags

Classifications

(not set)