Skip to main content
← All schemas

CreateCustomFieldInput

object

entityrequired
CustomFieldEntity
labelrequired
string
key
string or null

Stable key; derived from the label when absent.

typerequired
CustomFieldKind
is_required
boolean
section
string or null
help_text
string or null
visible_to
array of Id

Opaque record id.

editable_by
array of Id

Opaque record id.

Example
{
  "entity": "lead",
  "label": "string",
  "key": "string",
  "type": "text",
  "choices": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "is_required": true,
  "section": "string",
  "help_text": "string",
  "visible_to": [
    "cmusrceel0000q7kaafxqi1om"
  ],
  "editable_by": [
    "cmusrceel0000q7kaafxqi1om"
  ]
}