HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Edit specific campaign configuration.

put
https://{tenanturl}/v1.0/admin/campaigns/

Modify a specific campaign configuration. If called by an application owner, the API can modify only campaigns that the owner created or that the associated applications are all owned by the owner.
Entitlements required: tenantadmin [Tenant Administrator].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

Campaign configuration ID

Body Params

Object used to create a new campaign configuration

owner
object
required
string
enum
required

Campaign type

Allowed:
string
enum
required

Campaign priority

Allowed:
string
required

Campaign name

string

Campaign description

reviewer
object
applications
array of objects
required

List of applications the campaign certifies

applications*
allowlist
array of objects

List of users or groups allowed for the certification

allowlist
blocklist
array of objects

List of users or groups denied for the certification

blocklist
string
enum

Date when the first instance of the campaign starts

Allowed:
string
enum

Creation date of this campaign configuration

Allowed:
int64

The time in milliseconds how long each campaign instance remains open

string

A UNIX or Linux Cron-compatible string that defines the start of subsequent instances

runEvery
object
boolean

A flag to start the campaign immediately

string
enum

Forecast run date for the next campaign instance

Allowed:
string
enum

The action to be done for open records when a campaign closes

Allowed:
mitigationAction
object
defaultReviewer
object
boolean

A flag for a preview campaign, not opened to reviewers

boolean

A flag saying that the campaign is a continuous campaign

boolean

A flag for a campaign to refresh the existing filter for building dataset. It is valid for continuous campaigns only.

string
enum

The campaign sign-off policy

Allowed:
supervisors
array of objects

List of supervisors that were identified for the campaign

supervisors
boolean

Allow escalation to the supervisors

string

Campaign configuration ID

string

Campaign configuration revision

boolean
whitelist
array of objects

List of users or groups allowed for the certification

whitelist
blacklist
array of objects

List of users or groups denied for the certification

blacklist
Responses

500

Your operation can't be processed because an internal server error occurred.

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated over 2 years ago