Skip to main content
PATCH
Update a custom field rule

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required
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
label
string

Rule label

Required string length: 1 - 255
active
boolean

Whether the rule is active

source_custom_field_uuid
string

Source custom field UUID

source_values
(string | number | boolean)[]

Values that trigger the rule

Maximum array length: 100
action_type
enum<string>

Rule action: set_value, show_field, or value_mapping

Available options:
set_value,
show_field,
value_mapping
target_custom_field_uuid
string

Target custom field UUID

target_value
object · null · null

Value to set when action_type is set_value

value_mappings
object[] | null

Value mapping pairs for value_mapping rules

Maximum array length: 100
locked
boolean

Whether the target field is locked when the rule matches

entity_type
enum<string>

Entity type this rule applies to

Available options:
partner,
lead,
lead_deal,
contact

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
active
boolean
required
source_custom_field_uuid
string
required
source_values
(string | number | boolean)[]
required
action_type
enum<string>
required
Available options:
set_value,
show_field,
value_mapping
target_custom_field_uuid
string
required
target_value
object · null · null
required
value_mappings
object[] | null
required
locked
boolean
required
entity_type
enum<string>
required
Available options:
partner,
lead,
lead_deal,
contact
created_at
string
required
updated_at
string
required