Create privacy bucket
Creates Privacy Bucket using the API key’s account.
POST
/api/v1/privacy-bucketsprivacyBuckets: 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.
Premium icon options
PRO Custom and premium icons and premium icon colours require Pro. These option checks return 403; the endpoint itself remains available for supported free options.
Parameters
No path or query parameters.
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | Name of the resource. Minimum length: 1. Maximum length: 80. |
description | string | null | Optional | Description of the resource. Maximum length: 500. |
icon | string | null | Optional | Icon. Maximum length: 220. |
iconColorPreset | string | null | Optional | Icon Color Preset. Maximum length: 64. |
friendPermissions | object | null | Optional | Friend Permissions. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
name | string | Required | Name of the resource. |
description | string | Optional | Description of the resource. |
icon | string | Optional | Icon. |
iconColorPreset | string | Optional | Icon Color Preset. |
slug | string | Required | Slug. |
friendPermissions | object | Required | Friend Permissions. |
friendPermissions.members_view | string | Required | Members_view. Allowed values: "none", "read", "read_write". |
friendPermissions.member_profile | string | Required | Member_profile. Allowed values: "none", "read", "read_write". |
friendPermissions.member_avatar | string | Required | Member_avatar. Allowed values: "none", "read", "read_write". |
friendPermissions.member_notes | string | Required | Member_notes. Allowed values: "none", "read", "read_write". |
friendPermissions.member_custom_fields | string | Required | Member_custom_fields. Allowed values: "none", "read", "read_write". |
friendPermissions.member_statuses | string | Required | Member_statuses. Allowed values: "none", "read", "read_write". |
friendPermissions.member_relationships | string | Required | Member_relationships. Allowed values: "none", "read", "read_write". |
friendPermissions.groups | string | Required | Groups. Allowed values: "none", "read", "read_write". |
friendPermissions.front | string | Required | Front. Allowed values: "none", "read", "read_write". |
friendPermissions.front_history | string | Required | Front_history. Allowed values: "none", "read", "read_write". |
friendPermissions.friend_data | string | Required | Friend_data. Allowed values: "none", "read", "read_write". |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires privacyBuckets: 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.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request POST 'https://floralitys.com/api/v1/privacy-buckets' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "River"
}'Responses
Created.
{
"_id": "11111111-1111-4111-8111-111111111111",
"name": "River",
"description": "A note from our demo system.",
"icon": "demo",
"iconColorPreset": "#70846b",
"slug": "demo",
"friendPermissions": {
"members_view": "none",
"member_profile": "none",
"member_avatar": "none",
"member_notes": "none",
"member_custom_fields": "none",
"member_statuses": "none",
"member_relationships": "none",
"groups": "none",
"front": "none",
"front_history": "none",
"friend_data": "none"
},
"createdAt": 1767225600000,
"updatedAt": 1767225600000
}Example values are illustrative demo data.