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

put

https://{tenanturl}/v2.0/instances/{id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

Object used to create a new campaign instance.

eventType

string

required

The action to be applied to the campaign. Allowed values: 'cancel', 'pause', 'restart', 'runnow'.

Headers

x-admin-invocation

boolean

required

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

Responses

200

The request was successful.

400

Your request can't be processed. The error code and description are available in the response payload.

401

Your request can't be processed. The error code and description are available in the response payload.

403

Your request can't be processed. The error code and description are available in the response payload.

409

A conflict occurred during the replace operation.

500

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

Language

URL

Loading…