Create a custom field rule
curl --request POST \
--url https://api.journeybee.io/v1/custom-field-rules/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"source_custom_field_uuid": "<string>",
"target_custom_field_uuid": "<string>",
"source_values": [
"<string>"
],
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
],
"locked": true,
"conditions": [
{
"custom_field_uuid": "<string>",
"values": [
"<string>"
]
}
]
}
'import requests
url = "https://api.journeybee.io/v1/custom-field-rules/"
payload = {
"label": "<string>",
"source_custom_field_uuid": "<string>",
"target_custom_field_uuid": "<string>",
"source_values": ["<string>"],
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
],
"locked": True,
"conditions": [
{
"custom_field_uuid": "<string>",
"values": ["<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>',
source_custom_field_uuid: '<string>',
target_custom_field_uuid: '<string>',
source_values: ['<string>'],
target_value: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
value_mappings: [
{
sourceValue: '<string>',
targetValue: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
],
locked: true,
conditions: [{custom_field_uuid: '<string>', values: ['<string>']}]
})
};
fetch('https://api.journeybee.io/v1/custom-field-rules/', 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-field-rules/",
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>',
'source_custom_field_uuid' => '<string>',
'target_custom_field_uuid' => '<string>',
'source_values' => [
'<string>'
],
'target_value' => [
'text' => '<string>',
'textarea' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'value_mappings' => [
[
'sourceValue' => '<string>',
'targetValue' => [
'text' => '<string>',
'textarea' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]
],
'locked' => true,
'conditions' => [
[
'custom_field_uuid' => '<string>',
'values' => [
'<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-field-rules/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\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-field-rules/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/custom-field-rules/")
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 \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"active": true,
"source_custom_field_uuid": "<string>",
"source_values": [
"<string>"
],
"action_type": "set_value",
"target_custom_field_uuid": "<string>",
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
],
"conditions": [
{
"custom_field_uuid": "<string>",
"values": [
"<string>"
]
}
],
"condition_operator": "and",
"locked": true,
"entity_type": "partner",
"created_at": "<string>",
"updated_at": "<string>"
}Custom Field Rules
Create a custom field rule
POST
/
custom-field-rules
/
Create a custom field rule
curl --request POST \
--url https://api.journeybee.io/v1/custom-field-rules/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"source_custom_field_uuid": "<string>",
"target_custom_field_uuid": "<string>",
"source_values": [
"<string>"
],
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
],
"locked": true,
"conditions": [
{
"custom_field_uuid": "<string>",
"values": [
"<string>"
]
}
]
}
'import requests
url = "https://api.journeybee.io/v1/custom-field-rules/"
payload = {
"label": "<string>",
"source_custom_field_uuid": "<string>",
"target_custom_field_uuid": "<string>",
"source_values": ["<string>"],
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
],
"locked": True,
"conditions": [
{
"custom_field_uuid": "<string>",
"values": ["<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>',
source_custom_field_uuid: '<string>',
target_custom_field_uuid: '<string>',
source_values: ['<string>'],
target_value: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
},
value_mappings: [
{
sourceValue: '<string>',
targetValue: {
text: '<string>',
textarea: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
],
locked: true,
conditions: [{custom_field_uuid: '<string>', values: ['<string>']}]
})
};
fetch('https://api.journeybee.io/v1/custom-field-rules/', 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-field-rules/",
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>',
'source_custom_field_uuid' => '<string>',
'target_custom_field_uuid' => '<string>',
'source_values' => [
'<string>'
],
'target_value' => [
'text' => '<string>',
'textarea' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
],
'value_mappings' => [
[
'sourceValue' => '<string>',
'targetValue' => [
'text' => '<string>',
'textarea' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]
],
'locked' => true,
'conditions' => [
[
'custom_field_uuid' => '<string>',
'values' => [
'<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-field-rules/"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\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-field-rules/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/custom-field-rules/")
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 \"source_custom_field_uuid\": \"<string>\",\n \"target_custom_field_uuid\": \"<string>\",\n \"source_values\": [\n \"<string>\"\n ],\n \"target_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 \"value_mappings\": [\n {\n \"sourceValue\": \"<string>\",\n \"targetValue\": {\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 \"locked\": true,\n \"conditions\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"label": "<string>",
"active": true,
"source_custom_field_uuid": "<string>",
"source_values": [
"<string>"
],
"action_type": "set_value",
"target_custom_field_uuid": "<string>",
"target_value": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"value_mappings": [
{
"sourceValue": "<string>",
"targetValue": {
"text": "<string>",
"textarea": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
],
"conditions": [
{
"custom_field_uuid": "<string>",
"values": [
"<string>"
]
}
],
"condition_operator": "and",
"locked": true,
"entity_type": "partner",
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
application/json
Rule label
Required string length:
1 - 255Source custom field UUID. Lead and partner rules read only fields of their own entity_type with the target field's partner type. Deal (lead_deal) rules may also read the deal's lead fields and its partner's fields, as the source and as conditions, when the field's partner type matches the target's (distributor partner fields count as reseller).
Rule action: set_value, show_field, or value_mapping
Available options:
set_value, show_field, value_mapping Target custom field UUID. Must be a field of the rule's entity_type.
Entity type this rule applies to
Available options:
partner, lead, lead_deal Values that trigger the rule; {operator, value} objects are numeric threshold conditions for number source fields
Maximum array length:
100Value to set when action_type is set_value
Show child attributes
Show child attributes
Value mapping pairs for value_mapping rules
Maximum array length:
100Show child attributes
Show child attributes
Whether the target field is locked when the rule matches
Extra conditions, each on its own custom field, evaluated alongside the primary condition (source_custom_field_uuid + source_values). For show_field and set_value, the primary condition and every extra condition are combined with condition_operator. For value_mapping, the extra conditions form a gate: they are combined among themselves with condition_operator, and the first matching value_mappings row on the source field applies only while the gate passes. A condition matches when the field's value matches any of its values. Each condition field must be a distinct field, different from the source and target fields, that the rule may read (see source_custom_field_uuid). At most 20 conditions.
Maximum array length:
20Show child attributes
Show child attributes
How conditions combine: and (all must match) or or (any may match). For show_field and set_value it combines the primary condition with the extra conditions; for value_mapping it combines only the extra conditions (the gate). Defaults to and.
Available options:
and, or Response
201 - application/json
Default Response
Available options:
set_value, show_field, value_mapping Show child attributes
Show child attributes
Show child attributes
Show child attributes
Extra conditions, each on its own custom field, evaluated alongside the primary condition (source_custom_field_uuid + source_values). For show_field and set_value, the primary condition and every extra condition are combined with condition_operator. For value_mapping, the extra conditions form a gate: they are combined among themselves with condition_operator, and the first matching value_mappings row on the source field applies only while the gate passes. A condition matches when the field's value matches any of its values. Each condition field must be a distinct field, different from the source and target fields, that the rule may read (see source_custom_field_uuid). At most 20 conditions.
Show child attributes
Show child attributes
How conditions combine: and (all must match) or or (any may match). For show_field and set_value it combines the primary condition with the extra conditions; for value_mapping it combines only the extra conditions (the gate).
Available options:
and, or Available options:
partner, lead, lead_deal