curl --request POST \
--url https://api.1club.ai/v1/platform/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"required": true,
"requireOnSignup": true,
"contactTypes": [],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": true
}
'import requests
url = "https://api.1club.ai/v1/platform/custom-fields"
payload = {
"name": "<string>",
"label": "<string>",
"options": ["<string>"],
"required": True,
"requireOnSignup": True,
"contactTypes": [],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
options: ['<string>'],
required: true,
requireOnSignup: true,
contactTypes: [],
placeholder: '<string>',
defaultValue: '<string>',
isActive: true
})
};
fetch('https://api.1club.ai/v1/platform/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.1club.ai/v1/platform/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'required' => true,
'requireOnSignup' => true,
'contactTypes' => [
],
'placeholder' => '<string>',
'defaultValue' => '<string>',
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.1club.ai/v1/platform/custom-fields"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.1club.ai/v1/platform/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"label": "<string>",
"type": "text",
"options": [
"<string>"
],
"required": true,
"requireOnSignup": true,
"visibility": "Private",
"appliesTo": "self",
"contactTypes": [
"member"
],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": true,
"sortOrder": 123
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Create a contact custom field
Adds a field to every contact (or to the contactTypes named). A field members can see that is required must also be requireOnSignup, and requireOnSignup needs a member-visible visibility: otherwise a new member could never fill it in. A select field needs options. Requires contacts:write. Supports the Idempotency-Key header.
curl --request POST \
--url https://api.1club.ai/v1/platform/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"required": true,
"requireOnSignup": true,
"contactTypes": [],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": true
}
'import requests
url = "https://api.1club.ai/v1/platform/custom-fields"
payload = {
"name": "<string>",
"label": "<string>",
"options": ["<string>"],
"required": True,
"requireOnSignup": True,
"contactTypes": [],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
options: ['<string>'],
required: true,
requireOnSignup: true,
contactTypes: [],
placeholder: '<string>',
defaultValue: '<string>',
isActive: true
})
};
fetch('https://api.1club.ai/v1/platform/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.1club.ai/v1/platform/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'required' => true,
'requireOnSignup' => true,
'contactTypes' => [
],
'placeholder' => '<string>',
'defaultValue' => '<string>',
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.1club.ai/v1/platform/custom-fields"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.1club.ai/v1/platform/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"required\": true,\n \"requireOnSignup\": true,\n \"contactTypes\": [],\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"label": "<string>",
"type": "text",
"options": [
"<string>"
],
"required": true,
"requireOnSignup": true,
"visibility": "Private",
"appliesTo": "self",
"contactTypes": [
"member"
],
"placeholder": "<string>",
"defaultValue": "<string>",
"isActive": true,
"sortOrder": 123
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Headers
Retry-safe key; a repeat of the same request replays the first response
255Body
A contact custom field. name and type are required on create; on update send only what changes. Unknown fields are rejected.
100Defaults to the name
200text, textarea, number, boolean, select, date, time, email, url, phone 100Private, Member_only, Public self, dependent, both member, staff, lead, contact, lapsed, drop_in 200500Response
Custom field created
The field key, which a value is addressed by
What staff and members read
text, textarea, number, boolean, select, date, time, email, url, phone A select field's choices
Asked by every sign-up form
Private: staff only. Otherwise members see and edit it in the portal.
Private, Member_only, Public At sign-up: asked of the account holder, of each family member, or both
self, dependent, both The contact types it applies to; empty means every contact
member, staff, lead, contact, lapsed, drop_in Was this page helpful?