Skip to main content

CompanyLeadFieldDTO

CRM company custom field information object.

idint64

Field ID

Example: 1
namestring

Field name (default language)

Example: Client Type
nameUzstring

Field name (Uzbek)

Example: Mijoz turi
nameRustring

Field name (Russian)

Example: Тип клиента
nameEnstring

Field name (English)

Example: Client Type
nameTrstring

Field name (Turkish)

Example: Müşteri Tipi
nameTjstring

Field name (Tajik)

Example: Навъи муштарӣ
nameKystring

Field name (Kyrgyz)

Example: Кардардын түрү
typeFieldType

CRM field type enum.

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

Example: SELECT
infoTypeInfoType

Which entity a field/value belongs to.

  • LED — the lead
  • CONTACT — the contact

Possible values: [LED, CONTACT]

Example: LED
options object[]

Field options (for select / multi-select / radio / toggle).

  • Array [
    • idint64

    Field option ID

    Example: 1
    namestring

    Main name

    Example: VIP
    nameUzstring

    Name (Uzbek)

    Example: VIP
    nameRustring

    Name (Russian)

    Example: ВИП
    nameEnstring

    Name (English)

    Example: VIP
    nameTrstring

    Name (Turkish)

    Example: VIP
    nameTjstring

    Name (Tajik)

    Example: ВИП
    nameKystring

    Name (Kyrgyz)

    Example: ВИП
    updatedTimestampint64

    Update time (epoch seconds)

    Example: 1672531200
    descriptionstring

    Option description

    Example: Very important client
    colorstring

    Option color (hex)

    Example: #FF5733
    sortOrderinteger

    Option sort order

    Example: 1
  • ]
    • updatedTimestampint64

    Last update time (epoch seconds)

    Example: 1672531200
    descriptionstring

    Field description

    Example: Client category type
    currencies object[]

    Present only for NUMBER fields whose numberFormat is CURRENCY — the currencies selectable for the field's currencyId. Fetch the full list via GET /v1/open-api/currency.

  • Array [
    • idint32

    Currency ID

    Example: 1
    valuedouble

    Exchange rate (1 for the basic currency)

    Example: 1
    updateTimestampint64

    Last update time (epoch seconds)

    Example: 1672531200
    basicboolean

    Whether it's the company's basic currency

    Example: true
    ccystring

    Currency code

    Example: USD
  • ]
    • CompanyLeadFieldDTO
    {
      "id": 1,
      "name": "Client Type",
      "nameUz": "Mijoz turi",
      "nameRu": "Тип клиента",
      "nameEn": "Client Type",
      "nameTr": "Müşteri Tipi",
      "nameTj": "Навъи муштарӣ",
      "nameKy": "Кардардын түрү",
      "type": "SELECT",
      "infoType": "LED",
      "options": [
        {
          "id": 1,
          "name": "VIP",
          "nameUz": "VIP",
          "nameRu": "ВИП",
          "nameEn": "VIP",
          "nameTr": "VIP",
          "nameTj": "ВИП",
          "nameKy": "ВИП",
          "updatedTimestamp": 1672531200,
          "description": "Very important client",
          "color": "#FF5733",
          "sortOrder": 1
        }
      ],
      "updatedTimestamp": 1672531200,
      "description": "Client category type",
      "currencies": [
        {
          "id": 1,
          "value": 1,
          "updateTimestamp": 1672531200,
          "basic": true,
          "ccy": "USD"
        }
      ]
    }