cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

API to Enable or Disable Campaign Exclusion Reports for New Campaigns

API to Enable or Disable Campaign Exclusion Reports for New Campaigns

The Campaign Exclusion Report is disabled by default. If you need to enable it, you can use the following API. After you run this API, you can collect this data on all future certification campaigns.

 

CAUTION: Enabling this report can cause your campaigns to generate more slowly

 

See the following sections for more information:

Enable the Campaign Exclusion Report

 

POST <org>/cc/api/campaign/setCampaignConfiguration

{

  "exclusionReportsEnabled": <true | false>

}

 

View the Current Configuration for the Report

 

The current configuration can be queried using the corresponding GET API:

 

GET <org>/cc/api/campaign/getCampaignConfiguration

 

Where:

  • <org> is the URL for the customer's IdentityNow org
  • <true | false> if exclusion reports should be generated for new campaigns.

 

Examples

 

The default configuration retrieved from the org using the GET API should be:

{

  "exclusionReportsEnabled": false

}

 

If you want to enable exclusion reports for new campaigns, post this:

{

  "exclusionReportsEnabled": true

}

 

If you later want to disable exclusion reports for new campaigns, post this:

{

  "exclusionReportsEnabled": false

}

Version history
Revision #:
2 of 2
Last update:
‎May 26, 2022 07:52 PM
Updated by:
 
Contributors