Rename a taxonomy node

PATCH

/v1/taxonomy/nodes/{node_id}

const url = 'http://localhost:8080/v1/taxonomy/nodes/019f177f-9abe-78cd-8008-f40b58e3147d';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"tenant_id":"org-123","actor_id":"user-42","label":"Authentication Problems"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url http://localhost:8080/v1/taxonomy/nodes/019f177f-9abe-78cd-8008-f40b58e3147d \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "org-123", "actor_id": "user-42", "label": "Authentication Problems" }'

Renames a taxonomy node’s label and records a rename event attributed to actor_id. Tenant-scoped; returns 404 if the node does not belong to the tenant. While a tenant data purge runs for the same tenant_id, the request is rejected with HTTP 409 (code tenant_write_conflict) and may be retried.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

node_id

required

string format: uuid

Example

019f177f-9abe-78cd-8008-f40b58e3147d

Taxonomy node ID.

Request Body^required

application/json

Request to rename a taxonomy node.

object

tenant_id

required

string

>= 1 characters <= 255 characters /^[^\x00\uFFFD]*$/

actor_id

required

string

>= 1 characters <= 255 characters /^[^\x00]*$/

label

required

New node label.

string

>= 1 characters <= 2048 characters /^[^\x00]*$/

Examples

rename

Rename a node

{
  "tenant_id": "org-123",
  "actor_id": "user-42",
  "label": "Authentication Problems"
}

Responses

200

The updated node

application/json

A node in a taxonomy tree. Non-root nodes have a parent; leaf nodes reference the cluster they summarize.

object

required

string format: uuid

run_id

required

string format: uuid

parent_id

Parent node ID; absent for the root node.

string format: uuid

cluster_id

Cluster this node summarizes; typically present on leaf nodes.

string format: uuid

node_type

required

Position of a node within the taxonomy tree.

string

Allowed values: root branch leaf

label

required

string

original_label

Label as originally generated, before any rename.

string

description

string

level

required

Depth in the tree; the root is level 0.

integer format: int64

sort_order

required

integer format: int64

metadata

object

key

additional properties

any

removed_at

Set when the node has been soft-removed.

string format: date-time

removed_by

Actor that soft-removed the node.

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

children

Array<object> recursive

Example

{
  "node_type": "root"
}

400

Bad Request (e.g. invalid node_id, missing fields, or empty label)

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

Stable, machine-readable error code; the primary value to branch on. service_unavailable indicates a feature or dependency is temporarily unavailable and the request may be retried later. tenant_write_conflict indicates the write conflicted with an in-progress tenant data purge (or vice versa) and may be retried later unchanged. All other codes are terminal until the request itself is changed.

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

401

Unauthorized (missing or invalid API key)

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

404

Not Found – no node with this ID for the tenant.

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

409

Conflict – a tenant data purge for the same tenant_id is in progress (code tenant_write_conflict). The node was not changed; retry later.

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

413

Request body exceeds the maximum allowed size.

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

default

Error

application/problem+json

RFC 9457 problem details (application/problem+json). Branch on the stable code member rather than on title or type.

object

code

required

string

Allowed values: validation bad_request unauthorized forbidden not_found conflict tenant_write_conflict method_not_allowed content_too_large service_unavailable internal_server_error

detail

A human-readable explanation specific to this occurrence of the problem.

string

details

Optional structured context for this problem, e.g. resource_type on a 404.

object

key

additional properties

any

instance

A URI reference (typically the request path) identifying the specific occurrence of the problem.

string

invalid_params

Field-level validation failures (RFC 9457 “invalid_params” extension). Present on validation errors.

Array<object>

<= 100 items

A single invalid request parameter (RFC 9457 “invalid_params” extension member).

object

name

required

Dotted path to the offending request field, e.g. ‘field_type’ or ‘items[0].field_type’.

string

reason

required

Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints where applicable so the request can be corrected without guessing.

string

request_id

required

Identifier for this request, also returned in the X-Request-ID response header; include it when reporting a problem.

string

status

required

HTTP status code

integer format: int64

title

required

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference identifying the problem type.

string format: uri

Example

{
  "code": "validation",
  "detail": "One or more request parameters are invalid",
  "instance": "/v1/feedback-records",
  "invalid_params": [
    {
      "name": "field_type",
      "reason": "must be one of: text, categorical, nps, csat, ces, rating, number, boolean, date"
    }
  ],
  "request_id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "status": 400,
  "title": "Bad Request",
  "type": "https://hub.formbricks.com/problems/bad-request"
}

Rename a taxonomy node

Authorizations

Parameters

Path Parameters

Example

Request Bodyrequired

Examples

Responses

200

Example

400

Example

401

Example

404

Example

409

Example

413

Example

default

Example

Request Body^required