Update an access review campaign

Módulo Settings

PATCH/access-review-campaigns/{id}accessReviewCampaigns.update

A quarterly access review campaign. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad org.access_reviews.manage.
Alcances de OAuth: org.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

accessReviewCampaigns.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the access review campaign.

Cuerpo de la solicitud: AccessReviewCampaignUpdate

accessReviewCampaigns.update: AccessReviewCampaignUpdate
Campo	Tipo	Obligatorio	Descripción
name	string	No	Campaign name.Restricciones: length 1 to 300
due_on	string (date)	No	Due date.
auto_remove_unreviewed	boolean	No	Remove access left unreviewed after 14 days.

{
  "name": "Q4 Access Review",
  "due_on": "2026-10-08",
  "auto_remove_unreviewed": false
}

Respuesta 200: AccessReviewCampaign

accessReviewCampaigns.update: AccessReviewCampaign
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the access review campaign.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Sí	Campaign name.Restricciones: length 1 to 300
due_on	string (date)	Sí	Due date.
auto_remove_unreviewed	boolean	Sí	Remove access left unreviewed after 14 days.
campaign_state	string	Sí	Campaign state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
opened_at	string (date-time)	Sí	When the campaign opened and its items were taken.
closed_at	string (date-time) \| null	Sí	When the campaign completed or was canceled; null while Active.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Q4 Access Review",
  "due_on": "2026-10-08",
  "auto_remove_unreviewed": false,
  "campaign_state": "Active",
  "opened_at": "2026-10-08T14:30:00Z",
  "closed_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/access-review-campaigns/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"Q4 Access Review","due_on":"2026-10-08","auto_remove_unreviewed":false}'

const { data, etag } = await xos.accessReviewCampaigns.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Q4 Access Review",
    "due_on": "2026-10-08",
    "auto_remove_unreviewed": false
  }, { ifMatch: etag });

response = xos.access_review_campaigns.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Q4 Access Review", "due_on": "2026-10-08", "auto_remove_unreviewed": False}, if_match=etag)

xos access-review-campaigns update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Q4 Access Review","due_on":"2026-10-08","auto_remove_unreviewed":false}' --if-match auto