Skip to main content
POST
/
api
/
v1
/
custom-fields
Create Custom Field
curl --request POST \
  --url https://app.journeybee.io/api/v1/custom-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "<string>",
  "type": "<string>",
  "category": "<string>",
  "partner_type": "<string>",
  "required": true,
  "shared": true,
  "options": [
    {
      "label": "<string>"
    }
  ]
}'
{
  "id": 123,
  "uuid": "<string>"
}

​
Authentication

curl -X POST "https://app.journeybee.io/api/v1/custom-fields" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json" \
  -d '{"label": "Deal Size", "type": "select", "category": "lead_deal", "options": [{"label": "Small"}, {"label": "Medium"}, {"label": "Large"}]}'

​
Request Body Schema

​
label
string
required
Field label/name
​
type
string
required
Field type. Options: text, textarea, number, date, boolean, select, multi_select
​
category
string
required
Field category. Options: lead, lead_deal, partner
​
partner_type
string
Partner type association. Options: referral, reseller
​
required
boolean
Whether field is required (default: false)
​
shared
boolean
Whether field is shared with partners (default: false)
​
options
array
Array of option objects for select/multi-select fields

​
Response Schema

​
id
number
The created custom field ID
​
uuid
string
The created custom field UUID

​
Notes

  • Requires API key with write_access permission
  • Shared fields are automatically created in partner companies