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,
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>"
}
'import requests
url = "https://api.journeybee.io/v1/custom-fields/"
payload = {
"label": "<string>",
"options": [{ "label": "<string>" }],
"shared": True,
"required": True,
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>"
}
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({
label: '<string>',
options: [{label: '<string>'}],
shared: true,
required: true,
description: '<string>',
link_url: '<string>',
link_label: '<string>'
})
};
fetch('https://api.journeybee.io/v1/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.journeybee.io/v1/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([
'label' => '<string>',
'options' => [
[
'label' => '<string>'
]
],
'shared' => true,
'required' => true,
'description' => '<string>',
'link_url' => '<string>',
'link_label' => '<string>'
]),
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.journeybee.io/v1/custom-fields/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\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.journeybee.io/v1/custom-fields/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/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 \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"category": "lead",
"partner_type": "referral",
"options": [
{
"id": 123,
"label": "<string>"
}
],
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>",
"shared": true,
"required": true,
"created_at": "<string>",
"updated_at": "<string>"
}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,
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>"
}
'import requests
url = "https://api.journeybee.io/v1/custom-fields/"
payload = {
"label": "<string>",
"options": [{ "label": "<string>" }],
"shared": True,
"required": True,
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>"
}
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({
label: '<string>',
options: [{label: '<string>'}],
shared: true,
required: true,
description: '<string>',
link_url: '<string>',
link_label: '<string>'
})
};
fetch('https://api.journeybee.io/v1/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.journeybee.io/v1/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([
'label' => '<string>',
'options' => [
[
'label' => '<string>'
]
],
'shared' => true,
'required' => true,
'description' => '<string>',
'link_url' => '<string>',
'link_label' => '<string>'
]),
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.journeybee.io/v1/custom-fields/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\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.journeybee.io/v1/custom-fields/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/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 \"label\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\"\n }\n ],\n \"shared\": true,\n \"required\": true,\n \"description\": \"<string>\",\n \"link_url\": \"<string>\",\n \"link_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"category": "lead",
"partner_type": "referral",
"options": [
{
"id": 123,
"label": "<string>"
}
],
"description": "<string>",
"link_url": "<string>",
"link_label": "<string>",
"shared": true,
"required": true,
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
Field label
Field type: text, textarea, email, website, phone, number, date, boolean, checkbox, select, or multi_select
text, textarea, email, website, phone, number, date, boolean, checkbox, select, multi_select Which entity type this field belongs to: partner, lead, or lead_deal
lead, partner, lead_deal, contact Which partner type can see this field: referral, reseller, or distributor
referral, reseller, distributor Options for select/multi_select fields. Select and multi_select fields require at least one option. Each option label must be non-empty after trimming. Each option gets an auto-assigned ID.
Show child attributes
Show child attributes
Whether this field is visible to partners in the portal
Whether a value is required when creating/updating the entity
Optional help text shown with the field
500Optional HTTP(S) URL linked from link_label
2048Optional text for the field link
100Response
Default Response
text, textarea, email, website, phone, number, date, boolean, checkbox, select, multi_select lead, partner, lead_deal, contact referral, reseller, distributor Show child attributes
Show child attributes