Perform an operation on a specified campaign instance that belong to a specified tenant.

This API is used to perform an operation on a specified campaign instance that belongs to a specified tenant.
The owners of the application can perform operation on a specified campaign instance that is created by them or includes at least one application owned by them.
Entitlements required: manageAccessWorkflow [Manage Access Request Work Flows].

Path Params
string
required

Campaign Instance ID

Body Params

Campaign instance payload details:

- eventType: The action to apply to the campaign instance.


Allowable values for eventType are: cancel, pause, restart, runnow.
cancel: 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
required

The action to be applied to the campaign.

Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses

500

Your request cannot be processed because an internal server error occurred.

Language
URL
Choose an example:
application/json