Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

entity_type*string

Value in"user" | "subscription" | "product" | "group"

key*string

Stable identifier stored in custom field value maps. Use lowercase letters and underscores only (snake_case). Must be unique per organization and entity type.

Match^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$

Length1 <= length

label*string

Human-readable label.

description?|

Optional help text.

field_type*string

is_required?boolean

When true, a value is required when no field set override applies.

Defaultfalse

is_user_editable?boolean

When true, end users may set or change this field on their profile or related resources.

Defaulttrue

is_user_visible?boolean

When true, the field may be shown in member-facing surfaces.

Defaulttrue

options?array<>|

Allowed values for select and multiselect types.

Response Body

`application/json`

curl -X POST "https://api.members.dev/v1/custom-fields" \  -H "Content-Type: application/json" \  -d '{    "entity_type": "user",    "key": "string",    "label": "string",    "field_type": "text"  }'

{
  "id": "string",
  "entity_type": "user",
  "key": "string",
  "label": "string",
  "description": "string",
  "field_type": "text",
  "is_required": true,
  "is_user_editable": true,
  "is_user_visible": true,
  "options": [
    null
  ],
  "is_active": true,
  "created_at": null,
  "updated_at": null
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Custom Field

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`