Skip to content

Create a scope node

Projects module

POST/scope-nodesscopeNodes.create

A node of the project scope tree: engagement root, standing venue or show. Creates a scope node. 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 projects.scope.write.
  • OAuth scopes: projects.
  • 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: ScopeNodeCreate

scopeNodes.create: ScopeNodeCreate
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project.
parent_idstring (uuid) | nullNoIdentifier of the parent scope node.
scope_codestringYesScope code, unique in the project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringYesScope node name.Constraints: length 1 to 300
node_kindstringYesKind 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&'/.()-]+)*$
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_code": "E01",
  "name": "Opening Weekend",
  "node_kind": "Show"
}

Response 201: ScopeNode

scopeNodes.create: ScopeNode
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the scope node.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
parent_idstring (uuid) | nullYesIdentifier of the parent scope node.
scope_codestringYesScope code, unique in the project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringYesScope node name.Constraints: length 1 to 300
node_kindstringYesKind 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&'/.()-]+)*$
pathstringYesMaterialized 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 POST "$XOS_BASE_URL/scope-nodes" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","parent_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}'
const { data } = await xos.scopeNodes.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "scope_code": "E01",
    "name": "Opening Weekend",
    "node_kind": "Show"
  });
response = xos.scope_nodes.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scope_code": "E01", "name": "Opening Weekend", "node_kind": "Show"})
xos scope-nodes create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","parent_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_code":"E01","name":"Opening Weekend","node_kind":"Show"}'