githubEdit

CustomFieldAttributes

Attributes of the CustomFieldAttributes type

Attributes for creating and updating a custom field

{
  "label": "",
  "name": "",
  "fieldType": "",
  "parentObject": "",
  "position": 123,
  "size": "",
  "required": true
}
Name
Type
Description

label

String

Display label for the field

name

String

Schema name for the field (camelCase, e.g., churnDate)

fieldType

String

Data type: string, integer, date, rich_text, boolean

parentObject

String

Object type this field belongs to (e.g., account, contact)

position

Int

Sort order position

size

String

Field size: quarter, half, full

required

Boolean

Whether the field is required

Last updated

Was this helpful?