Skip to main content

LeadTaskFieldDTO

Lead task custom field definition, returned by GET /v1/open-api/lead-task-field. Same shape as ContractFieldDTO, plus requiredStatuses. Null-valued properties are omitted from the response JSON entirely (not sent as null).

idint64nullable

Field ID

Example: 12
namestringnullable

Field name

Example: Contact method
typeCustomFieldType

Custom field type, shared by every custom-field family (contract, flat, payment and lead task). Serialized by name. Identical value set to ContractFieldType, which remains as the contract-family alias.

Possible values: [TEXT, EXTENDED_TEXT, DATE, SELECT, MULTI_SELECT, RADIO, TOGGLE_SWITCH, URL, TAG, LOCATION, COUNTER, ADDRESS, EMPLOYEE, FILE, NUMBER]

Example: SELECT
options object[]nullable

Field options (for SELECT/MULTI_SELECT/RADIO/TOGGLE_SWITCH).

  • Array [
    • idint64

    Option ID

    Example: 1
    namestring

    Option name

    Example: Phone
    descriptionstringnullable

    Option description

    colorstringnullable

    Display color

    Example: #FF5733
    sortOrderint32

    Display order

    Example: 1
  • ]
    • requiredbooleannullable

    Whether the field is mandatory

    Example: false
    requiredStatusesLeadTaskStatus[]

    Statuses the task is required to have this field filled in before it can be transitioned to — a status-conditional form of required. Specific to the lead task field family; empty array [] when not restricted.

    Possible values: [OPEN, SUCCESS, FAILED, DELETED]

    Example: []
    descriptionstringnullable

    Field description

    iconstringnullable

    Icon code

    maxElementsint32nullable

    Max element count for multi-value types

    numberFormatNumberFormatnullable

    For type: NUMBER — how the value is formatted.

    Possible values: [NUMBER, PERCENT, CURRENCY]

    Example: NUMBER
    decimalPlacesint32nullable

    For type: NUMBER — decimal places.

    visualizationNumberVisualizationnullable

    For type: NUMBER — display style.

    Possible values: [BAR, RING, NUMBER]

    Example: NUMBER
    maxValuedoublenullable

    For type: NUMBER — upper bound.

    ordersint32nullable

    Display order

    LeadTaskFieldDTO
    {
      "id": 12,
      "name": "Contact method",
      "type": "SELECT",
      "options": [
        {
          "id": 1,
          "name": "Phone",
          "description": "string",
          "color": "#FF5733",
          "sortOrder": 1
        }
      ],
      "required": false,
      "requiredStatuses": [],
      "description": "string",
      "icon": "string",
      "maxElements": 0,
      "numberFormat": "NUMBER",
      "decimalPlaces": 0,
      "visualization": "NUMBER",
      "maxValue": 0,
      "orders": 0
    }