Update a project assignment
Identity module
PATCH/project-assignments/{id}projectAssignments.update
A person on a project, with scope nodes and dates. 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.
- Requires the capability projects.members.manage.
- OAuth scopes: projects.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project assignment. |
Request body: ProjectAssignmentUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| valid_from | string (date-time) | No | When the assignment starts. |
| valid_to | string (date-time) | null | No | When the assignment ends; null while open. |
| project_role | "Producer" | "Department Head" | "Coordinator" | "Field Supervisor" | "Field" | No | Project role. |
{
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"project_role": "Producer"
}Response 200: ProjectAssignment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project assignment. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| valid_from | string (date-time) | Yes | When the assignment starts. |
| valid_to | string (date-time) | null | Yes | When the assignment ends; null while open. |
| membership_id | string (uuid) | Yes | Identifier of the org membership of the person, in the project's org. |
| project_role | "Producer" | "Department Head" | "Coordinator" | "Field Supervisor" | "Field" | Yes | Project role. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_role": "Producer"
}Code samples
curl -X PATCH "$XOS_BASE_URL/project-assignments/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 '{"valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z","project_role":"Producer"}'const { data, etag } = await xos.projectAssignments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"project_role": "Producer"
}, { ifMatch: etag });response = xos.project_assignments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"valid_from": "2026-10-08T14:30:00Z", "valid_to": "2026-10-08T14:30:00Z", "project_role": "Producer"}, if_match=etag)xos project-assignments update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z","project_role":"Producer"}' --if-match auto