Update Node
Renames a node and updates its branding: logo and brand colours. The request is a multipart/form-data form so the logo can be uploaded in the same call. name is always required — send the current name to change only the branding.
Required permission: node:update
Request
PUT /v2/admin/nodes/{node_id}
Parameters
| Name | Type | In | Description |
|---|---|---|---|
node_id | string | path | Required. The node's id |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Content-Type | Required. multipart/form-data |
Body
Form fields:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Node name |
logo | file | No | New logo image, smaller than 2 MB. Replaces the current logo |
delete_logo | boolean | No | true removes the current logo. Ignored when logo is sent |
primary_color | string | No | Primary brand colour. Applied only together with secondary_color |
secondary_color | string | No | Secondary brand colour. Applied only together with primary_color |
Example
curl --request PUT \
--url '{{baseUrl}}/v2/admin/nodes/6a4bef2b1e781b11c22e9707' \
--header 'Authorization: Bearer <access_token>' \
--form 'name=Tostik 5' \
--form 'logo=@./logo.png' \
--form 'primary_color=#1F2937' \
--form 'secondary_color=#F59E0B'
Response
200 OK with an empty body. Read the node again with Get Node to see the result.
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10015 | Validation failed (missing name), the logo is 2 MB or larger, or the request is not multipart/form-data |
| 400 | 10016 | node_id is not a valid id |
| 400 | 10001 | Node not found (node domain 2) |
| 403 | 10005 | The node is outside your part of the hierarchy (node domain 2) |
See Errors for the error format and common codes.