Set a custom field value on an entity
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.
Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
UUID of the custom field definition
Entity type: partner, lead, or lead_deal
partner, lead, lead_deal UUID of the entity
^([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 — set the key matching the field type (text, number, date, boolean, select, multi_select)
Response
Default Response
text, textarea, number, date, boolean, select, multi_select Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs).
partner, lead, lead_deal