Skip to content

Delete a campaign

Request

OAuth 2.0 scope:
  • okta.governance.accessCertifications.manage
Admin roles:
  • ACCESS_CERTIFICATIONS_ADMIN

Deletes a campaign from your organization.

Only campaigns with a status of SCHEDULED or ERROR can be deleted. Attempting this operation with campaigns in any other status yields a 409 Conflict response indicating the state of the campaign is incompatible with the delete operation.

If the campaign being deleted has a schedule type RECURRING, then any occurence of future campaigns as per recurring schedule, will not happen.

Note: There is a limit on the number of campaigns with a status of SCHEDULED. Deleting campaigns that are never meant to be launched (whether through the launch operation or automatically through scheduleSettings), can be useful to remain under this limit.

Path
campaignIdstringrequired

Unique identifier for the campaign

curl -i -X DELETE \
  'https://subdomain-okta.login.adsbillinghub.com/governance/api/v1/campaigns/{campaignId}'

Responses

A successful campaign delete response

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Response
No content