Create sub system
Creates Sub System using the API key’s account.
POST
/api/v1/systems/sub-systemssystems: 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
No path or query parameters.
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
sideSystemId | string (uuid) | Required | Side System Id. |
parentSubSystemId | string (uuid) | null | Optional | Parent Sub System Id. |
linkedMemberId | string (uuid) | Required | Linked Member Id. |
name | string | Required | Name of the resource. Minimum length: 1. Maximum length: 80. |
description | string | Optional | Description of the resource. Maximum length: 280. |
icon | string | Optional | Icon. |
tagCode | string | Optional | Tag Code. Maximum length: 10. |
tagColor | string | Optional | Tag Color. Pattern: ^#[0-9A-Fa-f]{6}$. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
sideSystemId | string | Required | Side System Id. |
parentSubSystemId | null | string | Optional | Parent Sub System Id. |
linkedMemberId | null | string | Optional | Linked Member Id. |
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. |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
Errors
400· JSON errorInvalid JSON body.
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 POST 'https://floralitys.com/api/v1/systems/sub-systems' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"linkedMemberId": "11111111-1111-4111-8111-111111111111",
"name": "River"
}'Responses
Created.
{
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"parentSubSystemId": null,
"linkedMemberId": null,
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"tagCode": "demo",
"tagColor": "#70846b",
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}Example values are illustrative demo data.
