Update side system
Updates side system for the authorised account.
PATCH
/api/v1/systems/side-systems/{sideSystemId}systems: read_write1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
sideSystemId | string (uuid) | Required | Identifier of the side system. |
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Name of the resource. Minimum length: 1. Maximum length: 80. |
description | string | Optional | Description of the resource. Maximum length: 280. |
icon | string | Optional | Icon. Maximum length: 64. |
tagCode | string | Optional | Tag Code. Maximum length: 10. |
tagColor | string | Optional | Tag Color. Pattern: ^#[0-9A-Fa-f]{6}$. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
name | string | Required | Name of the resource. |
description | string | Optional | Description of the resource. |
icon | string | Optional | Icon. |
tagCode | string | Optional | Tag Code. |
tagColor | string | Optional | Tag Color. |
memberCount | number | Optional | Member Count. Active members on this side, including those in a nested sub. |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
Errors
400· JSON errorMissing side system id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires systems: read_write; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request PATCH 'https://floralitys.com/api/v1/systems/side-systems/11111111-1111-4111-8111-111111111111' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "River"
}'Responses
Successful response.
{
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"tagCode": "demo",
"tagColor": "#70846b",
"memberCount": 0,
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}Example values are illustrative demo data.