Перейти к основному содержимому

LeadSearchFilter

Переиспользуемый набор фильтров лидов (те же, что в поиске лидов), используемый здесь для нацеливания кампании ручной рассылки.

product_idProduct Idrequired

Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

id object

Найти одного лида по id.

anyOf
integer
lead_idsinteger[]

Найти заданный набор идентификаторов лидов.

stage_idsinteger[]

Найти лидов на любом из этих этапов.

name object

Найти по имени лида.

anyOf
string
crm_id object

Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

anyOf
string
is_active object

Найти по флагу активности.

anyOf
boolean
is_test object

Найти по флагу теста.

anyOf
boolean
batch_name object

Найти по имени партии импорта.

anyOf
string
tag_idsinteger[]

Найти лидов, имеющих любой из этих тегов.

contact object

Найти по значению контакта.

anyOf
string
crm_fields_conditions object

Составные условия по CRM-полям (AND/OR с операторами для каждого поля).

anyOf
operatorCRMFieldsConditionsOperator

Possible values: [AND, OR]

Default value: AND
conditions object[]
  • Array [
  • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
  • LeadSearchFilter
    {
    "product_id": 0,
    "id": 0,
    "lead_ids": [
    0
    ],
    "stage_ids": [
    0
    ],
    "name": "string",
    "crm_id": "string",
    "is_active": true,
    "is_test": true,
    "batch_name": "string",
    "tag_ids": [
    0
    ],
    "contact": "string",
    "crm_fields_conditions": {
    "operator": "AND",
    "conditions": [
    {
    "field": "string",
    "operator": "EQUALS"
    }
    ]
    }
    }