Update Access Review

patch

https://api.lumos.com/access_reviews/{access_review_id}

Update an existing access review campaign. Top-level fields are editable on any review that is not yet COMPLETED. Per-app (apps[].scope_filters) edits are only accepted while the ARDA is still in IN_PREPARATION or ASSIGNING_REVIEWERS status.

Fields absent from the body are left untouched. Setting a target_launch_date moves the review to SCHEDULED; sending it as null unschedules the review and turns off any recurrence. Scheduling fields cannot be changed while the review's apps are being snapshotted (IN_PREPARATION, SCHEDULED_IN_PREPARATION).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

access_review_id

string

required

Body Params

name

Name of the access review campaign.

deadline_at

Deadline by which reviewers must complete their reviews. ISO 8601 datetime (e.g. '2026-05-01T00:00:00Z').

owner_id

UUID of the user to set as the review owner.

target_launch_date

Date the review is scheduled to launch on, as an ISO 8601 datetime; the time of day is ignored. Send null to unschedule the review, which also turns off any recurrence. Must not be in the past, and must not be after deadline_at.

recurrence_config

RecurrenceConfigInput | null

Recurrence configuration. Mutually exclusive with recurrence_days_frequency; setting it clears that field. Send null to stop the review recurring. Only accepted on a review that has a target_launch_date.

recurrence_days_frequency

Recurrence frequency in days. Mutually exclusive with recurrence_config; setting it clears that field. Send null to stop the review recurring. Only accepted on a review that has a target_launch_date.

apps

array of objects

Per-app (ARDA) fields to update.

Apps

Responses

400

Validation error — the request violated a business rule (e.g. duplicate review name, deadline in the past, review not in the required status for this operation).

403

Forbidden — the caller lacks permission to create or manage access reviews. Requires the Access Review Administrator or App Admin role on the domain.

404

Not found — the referenced review / app does not exist.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error