Updates the list of assignments on a specified campaign instance that belong to a specified tenant.

patch

https://{tenanturl}/v2.0/instance/{id}/assignments

The API is used to update the list of assignments on a specified campaign instance that belong to a specified tenant.
The owners of the application can update the list of assignments on a campaign that is created by them or includes at least one application owned by them.
Entitlements required: manageAccessWorkflow [Manage Access Work Flows].

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Campaign Instance ID

Query Params

asSupervisor

boolean

Consider the calling user as a supervisor of the campaign when set to true.

assignmentSource

string

Defaults to assigned

Filter campaign instances based on the source: 'all', 'assigned', 'delegated'.

Body Params

List of campaign assignments to modify:
Campaign assignment payload details:

- id: Campaign assignment ID.
- reviewer: Details about the campaign reviewer. Required when redirecting an assignment to another user.
- operation: The operation to be executed.

Allowable values for operation are: approved, rejected, redirected, escalated.
approved: Approve an assignment.
rejected: Reject an assignment.
redirected: Redirect an assignment.
escalated: Escalate an assignment.

- justification: A justification for the action taken on the assignment by the reviewer.
- doImmediateFulfillment: Immediate action on the assignment when signOff is manual and doImmediateFulfillment is set to true.

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.

409

A conflict occurred during the replace operation.

500

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

Language

URL

Loading…