Skip to main content
PATCH
Update a custom field definition

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer cb_live_.... Create one in Settings → API Keys. See public_api.md § 3 for scopes.

Path Parameters

id
integer
required

Body

Used for both create (data=...) and update (instance, data=..., partial=True) — see _create_custom_field_definition_for_workspace/_update_..._for_workspace, mirroring TicketPipelineCreateSerializer. partial=True already relaxes required-ness for updates, so no per-field extra_kwargs needed.

name
string
Required string length: 1 - 100
Pattern: ^[-a-zA-Z0-9_]+$
label
string
Required string length: 1 - 255
field_type
enum<string>
  • text - Text
  • number - Number
  • boolean - Boolean
  • date - Date
  • select - Select
  • multi_select - Multi-select
Available options:
text,
number,
boolean,
date,
select,
multi_select
applies_to
enum<string>
  • contact - Contact
  • conversation - Conversation
  • both - Both
Available options:
contact,
conversation,
both
options
any
position
integer
Required range: 0 <= x <= 2147483647

Response

id
integer
required
read-only
name
string
required
Maximum string length: 100
Pattern: ^[-a-zA-Z0-9_]+$
label
string
required
Maximum string length: 255
field_type
enum<string>
required
  • text - Text
  • number - Number
  • boolean - Boolean
  • date - Date
  • select - Select
  • multi_select - Multi-select
Available options:
text,
number,
boolean,
date,
select,
multi_select
created_at
string<date-time>
required
read-only
applies_to
enum<string>
  • contact - Contact
  • conversation - Conversation
  • both - Both
Available options:
contact,
conversation,
both
options
any
position
integer
Required range: 0 <= x <= 2147483647