Set a custom field value on a lead
curl --request PUT \
--url https://api.journeybee.io/v1/leads/{uuid}/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
'import requests
url = "https://api.journeybee.io/v1/leads/{uuid}/custom-fields"
payload = {
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_field_uuid: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
})
};
fetch('https://api.journeybee.io/v1/leads/{uuid}/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/leads/{uuid}/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]),
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/leads/{uuid}/custom-fields"
payload := strings.NewReader("{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.journeybee.io/v1/leads/{uuid}/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/leads/{uuid}/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}Lead Custom Field Values
Set a custom field value on a lead
Custom field values are validated server-side — required fields, rules, visibility, and locks are all enforced; a validation failure returns a 400 with per-field details, each entry carrying a machine-readable reason.
PUT
/
leads
/
{uuid}
/
custom-fields
Set a custom field value on a lead
curl --request PUT \
--url https://api.journeybee.io/v1/leads/{uuid}/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
'import requests
url = "https://api.journeybee.io/v1/leads/{uuid}/custom-fields"
payload = {
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_field_uuid: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
})
};
fetch('https://api.journeybee.io/v1/leads/{uuid}/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/leads/{uuid}/custom-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]),
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/leads/{uuid}/custom-fields"
payload := strings.NewReader("{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.journeybee.io/v1/leads/{uuid}/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/leads/{uuid}/custom-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
⌘I