Create custom field definition
Creates Custom Field Definition using the API key’s account.
POST
/api/v1/members/{memberId}/custom-fieldscustomFields: 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 |
|---|---|---|---|
memberId | string (uuid) | Required | Identifier of the member. |
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
label | string | Required | Label. |
type | string | Required | Type. Allowed values: "text", "markdown", "color", "date", "birthday", "day_month", "month_year", "year", "tags", "url", "image", "photo_gallery", "featured_song", "featured_playlist", "separator". |
orderIndex | integer | Required | Order Index. |
description | string | Optional | Description of the resource. |
required | boolean | Optional | Required. |
insertAtStart | boolean | Optional | Insert At Start. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
Errors
400· JSON errorMissing member id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires customFields: 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.
Responses
Created.
Example values are illustrative demo data.