Skip to main content
POST
Set a custom field value on an entity

Authorizations

Authorization
string
header
required

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

Body

application/json
custom_field_uuid
string
required

UUID of the custom field definition

entity_type
enum<string>
required

Entity type: partner, lead, or lead_deal

Available options:
partner,
lead,
lead_deal
entity_uuid
string<uuid>
required

UUID of the entity

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)$
value
object | null
required

Value object — set text for text-like fields (text, textarea, email, website, phone), or the corresponding number, date, boolean, checkbox, select, or multi_select key

Response

201 - application/json

Default Response

uuid
string
required
custom_field_uuid
string
required
custom_field_label
string
required
custom_field_type
enum<string>
required
Available options:
text,
textarea,
email,
website,
phone,
number,
date,
boolean,
checkbox,
select,
multi_select
value
object | null
required
entity_type
enum<string>
required
Available options:
partner,
lead,
lead_deal
entity_uuid
string
required
created_at
string
required
updated_at
string
required