Set group layout
Sets group layout for the authorised account.
PUT
/api/v1/groups/{groupId}/layoutgroupLayout: 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 |
|---|---|---|---|
groupId | string (uuid) | Required | Identifier of the group. |
Request body
application/json · required
| Name | Type | Required | Description |
|---|---|---|---|
entries | array<object> | Required | Entries. |
entries[].type | string | Required | Type. Allowed values: "folder", "member", "separator". |
entries[].position | number | Required | Position. |
entries[].folderId | string (uuid) | Optional | Folder Id. |
entries[].memberId | string (uuid) | Optional | Associated member identifier. |
entries[].separatorLabel | string | Optional | Separator Label. |
entries[].separatorColorPreset | string | Optional | Separator Color Preset. |
entries[].separatorIcon | string | Optional | Separator Icon. |
Response schema
204
Successful operation. No response body.
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires groupLayout: read_write; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorRequest failed (CONFLICT).
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
503· JSON errorPostgreSQL is not configured (DATABASE_URL).
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request PUT 'https://floralitys.com/api/v1/groups/11111111-1111-4111-8111-111111111111/layout' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"entries": [
{
"type": "folder",
"position": 0,
"folderId": "11111111-1111-4111-8111-111111111111",
"memberId": "11111111-1111-4111-8111-111111111111",
"separatorLabel": "demo",
"separatorColorPreset": "#70846b",
"separatorIcon": "demo"
}
]
}'Responses
Successful operation. No response body.
No response body.
Example values are illustrative demo data.
