Update a scope node
Projects module
PATCH/scope-nodes/{id}scopeNodes.update
A node of the project scope tree: engagement root, standing venue or show. 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.scope.write.
- 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 scope node. |
Request body: ScopeNodeUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| scope_code | string | No | Scope code, unique in the project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| name | string | No | Scope node name.Constraints: length 1 to 300 |
| node_kind | string | No | Kind of node. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"scope_code": "E01",
"name": "Opening Weekend",
"node_kind": "Show"
}Response 200: ScopeNode
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the scope node. |
| 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. |
| parent_id | string (uuid) | null | Yes | Identifier of the parent scope node. |
| scope_code | string | Yes | Scope code, unique in the project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| name | string | Yes | Scope node name.Constraints: length 1 to 300 |
| node_kind | string | Yes | Kind of node. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| path | string | Yes | Materialized ltree path, derived.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"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",
"parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_code": "E01",
"name": "Opening Weekend",
"node_kind": "Show",
"path": "root.e01"
}Code samples
curl -X PATCH "$XOS_BASE_URL/scope-nodes/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 '{"scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}'const { data, etag } = await xos.scopeNodes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"scope_code": "E01",
"name": "Opening Weekend",
"node_kind": "Show"
}, { ifMatch: etag });response = xos.scope_nodes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"scope_code": "E01", "name": "Opening Weekend", "node_kind": "Show"}, if_match=etag)xos scope-nodes update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}' --if-match auto