Create an access review campaign
Settings module
POST/access-review-campaignsaccessReviewCampaigns.create
A quarterly access review campaign. Creates an access review campaign. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.access_reviews.manage.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: AccessReviewCampaignCreate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Campaign name.Constraints: length 1 to 300 |
| due_on | string (date) | Yes | 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
}Response 201: AccessReviewCampaign
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the access review campaign. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Campaign name.Constraints: length 1 to 300 |
| due_on | string (date) | Yes | Due date. |
| auto_remove_unreviewed | boolean | Yes | Remove access left unreviewed after 14 days. |
| campaign_state | string | Yes | Campaign state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| opened_at | string (date-time) | Yes | When the campaign opened and its items were taken. |
| closed_at | string (date-time) | null | Yes | 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"
}Code samples
curl -X POST "$XOS_BASE_URL/access-review-campaigns" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Q4 Access Review","due_on":"2026-10-08","auto_remove_unreviewed":false}'const { data } = await xos.accessReviewCampaigns.create({
"name": "Q4 Access Review",
"due_on": "2026-10-08",
"auto_remove_unreviewed": false
});response = xos.access_review_campaigns.create({"name": "Q4 Access Review", "due_on": "2026-10-08", "auto_remove_unreviewed": False})xos access-review-campaigns create --data '{"name":"Q4 Access Review","due_on":"2026-10-08","auto_remove_unreviewed":false}'