---
title: "Set Employee Inclusion"
method: PATCH
path: "/aurd-tracking/{claim_id}/employee-identities/{identity_id}/inclusion"
tags: ["au-rd-tracking"]
---

# Set Employee Inclusion

`PATCH /aurd-tracking/{claim_id}/employee-identities/{identity_id}/inclusion`

## Request

- Base URL: `https://api.claimkit.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.claimkit.co/aurd-tracking/{claim_id}/employee-identities/{identity_id}/inclusion`
- Auth: none declared

Unified admin endpoint to exclude or restore an employee identity.

``action='exclude'`` applies a manual exclusion lock (inclusion_status,
exclusion_reason, exclusion_source, excluded_at, excluded_by_user_id) and
mirrors to the legacy ``status`` column.

``action='restore'`` clears all five inclusion-related fields and resets
the legacy ``status`` / ``is_rd_contributor`` mirrors so the row is
eligible for automatic re-evaluation.

The legacy mirror writes will be removed in a follow-up PR once the
callers (and downstream filters) have been migrated to read from
``inclusion_status``.

## Path parameters

- `claim_id` integer, required
- `identity_id` integer, required

## Request body

- SetEmployeeInclusionRequest
  - `action` 'exclude' | 'restore', required

## Response `200`

Successful Response

- EmployeeIdentitySummary
  - `id` integer, required
  - `canonical_name` string, nullable, required
  - `status` string, required
  - `excluded_at` string, date-time, nullable
  - `is_rd_contributor` boolean, required
  - `identifiers` EmployeeIdentifierSummary[], required
    - `identifier_type` string, required
    - `identifier_value` string, required
    - `source_type` string, nullable, required
    - `source_id` string, nullable, required
  - `employment_start_date` string, date, nullable
  - `employment_end_date` string, date, nullable
  - `eligible_for_period` boolean, nullable
  - `inclusion_status` string, required
  - `exclusion_reason` string, nullable
  - `exclusion_source` string, nullable
  - `merged_into_id` integer, nullable
  - `merged_at` string, date-time, nullable
  - `in_engineering_group` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/claimkit/apis/claimkit-api.md) - [All operations](https://skmtc.dev/claimkit/apis/claimkit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/claimkit/apis/claimkit-api/revisions/94dc85ba5326?raw)
