1. Docs
  2. API Reference
  3. Update a hierarchy node

Update a hierarchy node

PATCH/api/v1/nodes/{id}

Updates a hierarchy node's mutable fields (name, description, slug, status, metadata, parent_node_id) in the current Environment, gated by hierarchy.manage on the node; reparenting is re-validated against the schema. Supply an If-Match header with the node's current version for optimistic concurrency — a stale value returns 409 with the current node state. Returns the updated node and writes a node.updated (or node.moved) audit row.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Headers

  • if-match required
  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since.

Request body

application/json

namestring Optional

Updated display name

descriptionstring Optional

Updated free-text description

slugstring Optional

Updated slug

statusstring Optional

Updated status (active/inactive)

metadataobject Optional

Updated metadata

parent_node_idstring Optional

New parent node ID (reparent)

Responses

application/json

  • dataNodeResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

NodeResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/nodes/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "slug": "string",
    "status": "string",
    "metadata": {},
    "parent_node_id": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "parent_node_id": "string",
    "node_type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "status": "string",
    "metadata": {},
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList hierarchy (scoped tree)
POSTCreate a hierarchy node
GETList the hierarchy as parent edges
GETGet a hierarchy node
DELETEDelete a hierarchy node
GETGet subtree from a node
GETGet ancestor chain for a node
GETGet direct children of a node
POSTMove (reparent) a node
GETList identities at a node
GETGet identity summary for a node
 Was this page helpful?

Tell us how we can improve this guide.

Canopy