Create member
Creates Member using the API key’s account.
POST
/api/v1/membersmembers: 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 |
|---|---|---|---|
name | string | Required | Name of the resource. Minimum length: 1. |
directoryId | string (uuid) | Optional | Containing folder identifier. |
homeGroupId | string (uuid) | Optional | Home Group Id. |
displayName | string | Optional | Display name. |
pronouns | string | Optional | Member pronouns. |
avatar | string | Optional | Avatar storage reference. |
about | string | Optional | Member profile text. |
background | string | Optional | Background storage reference. |
createdAt | integer | Optional | Creation time. |
clientMutationId | string (uuid) | Optional | Client Mutation Id. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|
Errors
400· JSON errorInvalid JSON body.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires members: 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.
503· JSON errorRequest failed (PRECONDITION_FAILED).
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request POST 'https://floralitys.com/api/v1/members' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "River"
}'Responses
Created.
"demo"Example values are illustrative demo data.