Deprecated - Modify specific campaign instance.

The api to modify a specific campaign instance v1.0 (v1.0/admin/instances/{id}) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: PUT /v2.0/instances/{id}
Modify a specific campaign instance. If called by application owner, the API can modify only instances that the owner created or that contain at least one application that the owner owns.
Entitlements required: manageAccessWorkflow [Manage Access Request Work Flows].

Path Params
string
required

Campaign Instance ID

Body Params

Campaign instance payload details:

- id: Campaign instance ID.
- eventType: The action to apply to the campaign instance.


Allowable values for eventType are: delete, pause, restart, runnow.
delete: Transitions the campaign instance to a cancelled state, indicating it is no longer active.
pause: Temporarily halts a running campaign instance, putting it in a paused state.
restart: Resumes a paused campaign instance, continuing its execution.
runnow: Triggers immediate execution of a scheduled campaign instance.

string

Campaign instance Id

string
required

The action to be applied to the campaign.

Responses

500

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

Language
URL
Choose an example:
application/json