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

Authorizations

​
Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
​
label
string
required

Field label

​
type
enum<string>
required

Field type: text, number, date, url, email, phone, select, multi_select, checkbox

Available options:
text,
textarea,
number,
date,
boolean,
select,
multi_select
​
category
enum<string>
required

Which entity type this field belongs to: partner, lead, or lead_deal

Available options:
lead,
partner,
lead_deal,
contact
​
partner_type
enum<string>
required

Which partner types can see this field: referral, reseller, distributor, or all

Available options:
referral,
reseller,
distributor
​
options
object[]

Options for select/multi_select fields. Each option gets an auto-assigned ID.

​
shared
boolean

Whether this field is visible to partners in the portal

​
required
boolean

Whether a value is required when creating/updating the entity

Response

201 - application/json

Default Response

​
uuid
string
required
​
label
string
required
​
type
enum<string>
required
Available options:
text,
textarea,
number,
date,
boolean,
select,
multi_select
​
category
enum<string>
required
Available options:
lead,
partner,
lead_deal,
contact
​
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
​
options
object[] | null
required
​
shared
boolean
required
​
required
boolean
required
​
created_at
string
required
​
updated_at
string
required