Skip to main content
POST
Create a contact custom field

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Body

application/json

A contact custom field. name and type are required on create; on update send only what changes. Unknown fields are rejected.

name
string
Maximum string length: 100
label
string

Defaults to the name

Maximum string length: 200
type
enum<string>
Available options:
text,
textarea,
number,
boolean,
select,
date,
time,
email,
url,
phone
options
string[]
Maximum array length: 100
required
boolean
requireOnSignup
boolean
visibility
enum<string>
Available options:
Private,
Member_only,
Public
appliesTo
enum<string>
Available options:
self,
dependent,
both
contactTypes
enum<string>[]
Available options:
member,
staff,
lead,
contact,
lapsed,
drop_in
placeholder
string
Maximum string length: 200
defaultValue
string
Maximum string length: 500
isActive
boolean

Response

Custom field created

id
integer
name
string

The field key, which a value is addressed by

label
string

What staff and members read

type
enum<string>
Available options:
text,
textarea,
number,
boolean,
select,
date,
time,
email,
url,
phone
options
string[]

A select field's choices

required
boolean
requireOnSignup
boolean

Asked by every sign-up form

visibility
enum<string>

Private: staff only. Otherwise members see and edit it in the portal.

Available options:
Private,
Member_only,
Public
appliesTo
enum<string>

At sign-up: asked of the account holder, of each family member, or both

Available options:
self,
dependent,
both
contactTypes
enum<string>[]

The contact types it applies to; empty means every contact

Available options:
member,
staff,
lead,
contact,
lapsed,
drop_in
placeholder
string | null
defaultValue
string | null
isActive
boolean
sortOrder
integer