Skip to main content
POST
/
ca
/
api
/
v1
/
custom-fields
Create Custom Field
curl --request POST \
  --url https://api.meetcampfire.com/ca/api/v1/custom-fields \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "label": "<string>",
  "field_type": "text",
  "options": "<any>",
  "is_required": true,
  "display_order": -1,
  "is_active": true
}'
{
  "id": 123,
  "app": "<string>",
  "model": "<string>",
  "name": "<string>",
  "label": "<string>",
  "field_type": "text",
  "options": "<any>",
  "is_required": true,
  "display_order": -1,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

name
string
required
Maximum length: 100
label
string
required
Maximum length: 100
field_type
enum<string>
required
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
Available options:
text,
single_select,
date,
number,
boolean
options
any
is_required
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
is_active
boolean

Response

201 - application/json
id
integer
required
app
string
required
model
string
required
name
string
required
Maximum length: 100
label
string
required
Maximum length: 100
field_type
enum<string>
required
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
Available options:
text,
single_select,
date,
number,
boolean
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_modified_at
string<date-time>
required
is_deleted
boolean
default:false
required
deleted_at
string<date-time> | null
required
options
any
is_required
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
is_active
boolean
I