Update a lead
curl --request PATCH \
--url https://api.journeybee.io/v1/leads/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
]
}
'import requests
url = "https://api.journeybee.io/v1/leads/{uuid}"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone_number: '<string>',
company_name: '<string>',
source: '<string>',
rejected_reason: '<string>',
accepted_reason: '<string>',
custom_fields: [
{
custom_field_uuid: '<string>',
value: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
]
})
};
fetch('https://api.journeybee.io/v1/leads/{uuid}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'company_name' => '<string>',
'source' => '<string>',
'rejected_reason' => '<string>',
'accepted_reason' => '<string>',
'custom_fields' => [
[
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'textarea' => '<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}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.journeybee.io/v1/leads/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/leads/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"status": "new",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"direction": "<string>",
"partner": {
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral"
},
"created_by": {
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"assigned_users": [
{
"uuid": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
],
"custom_fields": [
{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"status_form_fields": [
{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"created_at": "<string>",
"updated_at": "<string>"
}Leads
Update a lead
PATCH
/
leads
/
{uuid}
Update a lead
curl --request PATCH \
--url https://api.journeybee.io/v1/leads/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
]
}
'import requests
url = "https://api.journeybee.io/v1/leads/{uuid}"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone_number: '<string>',
company_name: '<string>',
source: '<string>',
rejected_reason: '<string>',
accepted_reason: '<string>',
custom_fields: [
{
custom_field_uuid: '<string>',
value: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
]
})
};
fetch('https://api.journeybee.io/v1/leads/{uuid}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'company_name' => '<string>',
'source' => '<string>',
'rejected_reason' => '<string>',
'accepted_reason' => '<string>',
'custom_fields' => [
[
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'textarea' => '<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}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.journeybee.io/v1/leads/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/leads/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"company_name\": \"<string>\",\n \"source\": \"<string>\",\n \"rejected_reason\": \"<string>\",\n \"accepted_reason\": \"<string>\",\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"textarea\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"company_name": "<string>",
"source": "<string>",
"status": "new",
"rejected_reason": "<string>",
"accepted_reason": "<string>",
"direction": "<string>",
"partner": {
"uuid": "<string>",
"name": "<string>",
"partner_type": "referral"
},
"created_by": {
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"assigned_users": [
{
"uuid": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
],
"custom_fields": [
{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"status_form_fields": [
{
"uuid": "<string>",
"label": "<string>",
"type": "text",
"value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"created_at": "<string>",
"updated_at": "<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
Valid email address. Surrounding whitespace is removed and letter casing is preserved. Send null or a blank string to clear it.
Valid international or national phone number. National values use the company's configured country and are stored in E.164 format. Send null or a blank string to clear it.
Moving a lead to converted (Accepted) or rejected applies that status's form (getLeadStatusForms lists each form's mode, fields and reason). When the company has made the form Required, every required field of the form (custom fields in the lead_acceptance / lead_rejection category) and its reason, when required, must be filled in: send them in custom_fields / accepted_reason / rejected_reason in the same request, or the update is refused with 400 validation_error naming each missing field. Leaving Accepted or Rejected clears that form's answers and its reason.
Available options:
new, converted, rejected The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Saved only while the lead is or becomes rejected; otherwise refused with not_accessible, unless it equals the stored value (no change). Ignored when the same request moves the lead out of rejected (leaving clears it).
Maximum string length:
2000The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Saved only while the lead is or becomes converted; otherwise refused with not_accessible, unless it equals the stored value (no change). Ignored when the same request moves the lead out of converted (leaving clears it).
Maximum string length:
2000Available options:
received, sent Custom field values saved with this update, by field uuid: lead fields (category lead) and the answers to the lead's status form (category lead_acceptance while the lead is or becomes converted, lead_rejection while it is or becomes rejected). Status-form answers go in the same request as the status change they belong to. A status-form field of another status is refused with not_accessible.
Maximum array length:
100Show child attributes
Show child attributes
Response
200 - application/json
Default Response
Available options:
new, converted, rejected The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Cleared when the lead leaves Rejected.
The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Cleared when the lead leaves Accepted.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Values of the lead's custom fields (category lead).
Show child attributes
Show child attributes
Answers to the form of the lead's current status: lead_acceptance fields while it is converted (Accepted), lead_rejection fields while it is rejected, empty otherwise. Includes internal (non-shared) fields. Write them with custom_fields on the lead update or the lead custom-field endpoints.
Show child attributes
Show child attributes