Update group
Updates group for the authorised account.
PATCH
/api/v1/groups/{groupId}groups: read_writedirectories: 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.
Groups and directories
The higher access level of
groups and directories is used. Either scope can satisfy this requirement; both are not required. read_write includes read access.Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
groupId | string (uuid) | Required | Identifier of the group. |
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Name of the resource. |
parentId | string (uuid) | null | Optional | Parent resource identifier. |
expectedVersion | integer | Optional | Expected current version; a mismatch can cause a conflict. Minimum: 0. |
description | string | null | Optional | Description of the resource. |
icon | string | null | Optional | Icon. |
colorPreset | string | null | Optional | Color Preset. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
parentId | string | Optional | Parent resource identifier. |
icon | string | Optional | Icon. |
iconColorPreset | string | Optional | Icon Color Preset. |
createdAt | number | Optional | Creation time. |
updatedAt | number | Optional | Most recent update time. |
version | number | Required | Version used for optimistic concurrency checks. |
sideSystemId | string | Optional | Side System Id. |
subSystemId | string | Optional | Sub System Id. |
deletedAt | number | Optional | Deletion time; null when active. |
purgeAt | number | Optional | Purge At. |
originalParentId | string | Optional | Original Parent Id. |
archivedAt | number | Optional | Archiving time; null when active. |
description | string | Optional | Description of the resource. |
_id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
name | string | Required | Name of the resource. |
Errors
400· JSON errorMissing group id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires groups or directories: read_write; ownership or feature restrictions may also deny access.
404· JSON errorGroup not found.
409· JSON errorRequest failed (CONFLICT).
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/groups/11111111-1111-4111-8111-111111111111' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "River"
}'Responses
Successful response.
{
"parentId": "11111111-1111-4111-8111-111111111111",
"icon": "demo",
"iconColorPreset": "#70846b",
"createdAt": 1767225600000,
"updatedAt": 1767225600000,
"version": 0,
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"subSystemId": "11111111-1111-4111-8111-111111111111",
"originalParentId": "11111111-1111-4111-8111-111111111111",
"description": "A note from our demo system.",
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"name": "River"
}Example values are illustrative demo data.