Create member status definition
Creates Member Status Definition using the API key’s account.
POST
/api/v1/member-statusesmemberStatuses: 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
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Optional | Unique identifier. |
name | string | Required | Name of the resource. Minimum length: 1. Maximum length: 48. Surrounding whitespace is removed. |
description | string | Optional | Description of the resource. Surrounding whitespace is removed. |
icon | string | Required | Icon. Minimum length: 1. |
iconType | string | Required | Icon Type. Allowed values: "emoji", "lucide", "custom". |
colour | string | null | Optional | Colour. |
avatarRingShape | string | Optional | Avatar Ring Shape. Allowed values: "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown", "moon". |
privacyBucketIds | array<string (uuid)> | Required | Privacy Bucket Ids. At least 1 items. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
name | string | Required | Name of the resource. |
description | null | string | Required | Description of the resource. |
icon | string | Required | Icon. |
iconType | string | Required | Icon Type. Allowed values: "custom", "emoji", "lucide". |
colour | null | string | Required | Colour. |
avatarRingShape | null | string | Required | Avatar Ring Shape. |
position | number | Required | Position. |
deletedAt | null | number | Required | Deletion time; null when active. |
purgeAt | null | number | Required | Purge At. |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
privacyBucketIds | array<string> | Required | Privacy Bucket Ids. |
Errors
400· JSON errorInvalid JSON body.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires memberStatuses: 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/member-statuses' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "River",
"icon": "demo",
"iconType": "emoji",
"privacyBucketIds": [
"11111111-1111-4111-8111-111111111111"
]
}'Responses
Created.
{
"id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"name": "River",
"description": null,
"icon": "demo",
"iconType": "custom",
"colour": null,
"avatarRingShape": null,
"position": 0,
"deletedAt": null,
"purgeAt": null,
"createdAt": 1767225600000,
"updatedAt": 1767225600000,
"privacyBucketIds": [
"11111111-1111-4111-8111-111111111111"
]
}Example values are illustrative demo data.