Skip to main content
PATCH
Update a custom field definition

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
shared
boolean
required
boolean
description
string | null
Maximum string length: 500
Maximum string length: 2048
Maximum string length: 100

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
type
enum<string>
required
Available options:
text,
textarea,
email,
website,
phone,
number,
date,
boolean,
checkbox,
select,
multi_select
category
enum<string>
required

Entity the field belongs to: partner, lead, lead_deal or contact. lead_acceptance and lead_rejection are the forms filled in when a lead moves to Accepted (status converted) or Rejected; their values belong to the lead. Status-form fields are one form per company: partner_type does not apply to them.

Available options:
lead,
partner,
lead_deal,
contact,
lead_acceptance,
lead_rejection
partner_type
enum<string> | null
required

Which partner type can see this field. On lead_acceptance / lead_rejection fields it is a stored default with no effect.

Available options:
referral,
reseller,
distributor
options
object[] | null
required
description
string | null
required
shared
boolean
required
required
boolean
required
created_at
string
required
updated_at
string
required