Edit specific campaign configuration.

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

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].

Path Params

string

required

Campaign configuration ID

Body Params

owner

object

required

type

string

required

Campaign type

priority

string

required

Campaign priority

name

string

required

Campaign name

description

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

launchDate

string

Date when the first instance of the campaign starts

creationDate

string

Creation date of this campaign configuration

duration

int64

The time in milliseconds how long each campaign instance remains open

frequency

string

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

runEvery

object

runNow

boolean

A flag to start the campaign immediately

nextRunDate

string

Forecast run date for the next campaign instance

overdueAction

string

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

mitigationAction

object

defaultReviewer

object

preview

boolean

A flag for a preview campaign, not opened to reviewers

continuous

boolean

A flag saying that the campaign is a continuous campaign

automaticRefreshContinuousCampaign

boolean

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

signOff

string

The campaign sign-off policy

supervisors

array of objects

List of supervisors that were identified for the campaign

supervisors

allowSupervisorEscalation

boolean

Allow escalation to the supervisors

string

Campaign configuration ID

rev

string

Campaign configuration revision

reviewerOverwritten

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.

Language

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://tenant_url/v1.0/admin/campaigns/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "userassignment",
8
  "priority": "high"
9
}
10
'

Choose an example:

application/json

200The operation was successful.

400A client-side status error occurred. The error code and description are available in the payload.

409A conflict occurred during the replace operation.