Skip to main content
POST
Act on Campaign

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

campaignId
string
required

Body

application/json
action
enum<string>
required
Available options:
approve,
run,
approve_and_run,
end,
resume,
retry,
approve_change,
discard_change
expectedRevision
integer
required
Required range: x <= 9007199254740991
expectedPendingVersion
integer
Required range: x <= 9007199254740991
organizationId
string

Required for session auth. Optional for an API key, which already identifies the organization.

Required string length: 1 - 120

Response

Campaign detail after the action, plus the scheduling result.

campaign
object
required
executions
object[]
required
audit
object[]
required
readiness
string[]
required

Issues that block approving or running the current plan.

pendingChangeIssues
string[]
required

Issues that block approving the proposed live change.

pendingScheduleCount
integer
required
Required range: 0 <= x <= 9007199254740991
failedScheduleCount
integer
required
Required range: 0 <= x <= 9007199254740991
waitingBrowserJobCount
integer
required
Required range: 0 <= x <= 9007199254740991
scheduling
object
required

pending is true when the schedule was saved but not yet acknowledged; retry the action to confirm.

scheduleIssues
object[]
recovery
object[]
cleanupFailed
boolean
progress
object