Модель контакта

Вид модели: 

{
  "id": "contact_id",
  "project_id": 123,
  "details": [
    {
      "id": "contact_detail_id",
      "type": "email/phone",
      "data": "email@example.com/+71234567890"
    }
  ],
  "fields": [
    {
      "id": "12",
      "type": "string",
      "name": "fieldName",
      "value": "exampleText"
    }
  ],
  "created_at": "DD.MM.YY HH:MM:SS",
  "name": "user_name",
  "site": "example.com"
}

Описание полей:

  • id: ID контакта
  • project_id - ID проекта, к которому был создан пользователь.
  • details - массив контактных данных:
    • id - ID контактных данных
    • type - Тип контактных данных
    • data - Контактные данные
  • fields - массив полей контакта:
    • id - ID поля контакта
    • type - Тип поля. Может быть: string, text, number, date
    • name - Имя поля контакта
    • value - Значение поля для конкретного контакта.

      При отсутствии значения - поле value передаваться не будет

  • created_at - дата создания (формат: DD.MM.YY HH.MM.SS)
  • name - Имя контакта
  • site - Личный сайт контакта

Используется при:

Модель проекта

Вид модели: 

{
    "id": 123,
    "name": "project_name",
    "page": "project_url",
    "domain": "domain_name"
}

Описание полей:

  • id- Уникальный номер проекта
  • name - Название проекта
  • page - Полное доменное имя (FQDN)
  • domain - Доменное имя в чистом виде

Используется при:

Модель лида

В случае корректного токена и успешного выполнения запроса Вы получите следующий результат: 

{
  "id": 2087883,
  "contact_id": 1981409,
  "name": "Mak",
  "view": {
    "id": 43,
    "source": "Api",
    "campaign": "CampaignName",
    "keyword": "keywordName"
  },
  "custom": [
    {
      "id": 344623,
      "name": "Владелец заявки",
      "type": "conv_owner",
      "value": {
        "id": 17873,
        "type": "main"
      }
    },
    {
      "id": 344624,
      "name": "Дата заявки",
      "type": "conv_date",
      "value": "09.05.17 16:54:40"
    }
  ],
  "payments": [
    {
      "category": "categoryName",
      "purpose": "purposeName",
      "sum": 41
    }
  ],
  "contact": {
    "id": "contact_id",
    "project_id": 123,
    "details": [
      {
        "id": "contact_detail_id",
        "type": "email/phone",
        "data": "email@example.com/+71234567890"
      }
    ],
    "fields": [
      {
        "id": "12",
        "type": "string",
        "name": "fieldName",
        "value": "exampleText"
      }
    ],
    "created_at": "DD.MM.YY HH:MM:SS",
    "name": "user_name",
    "site": "example.com"
  }
}

Описание полей:

  • id - ID лида
  • contact_id - ID контакта (вернее, person_id), к которому привязан лид
  • name - Имя лида
  • view - Просмотр, с которого был создан лид
    • id - ID просмотра
    • source - Источник
    • campaign - Кампания
    • keyword - Ключевое слово
  • custom - Блок работы с кастомными полями
    • id - ID поля
    • name - Название поля
    • type - Тип поля
    • value - Значение, либо массив значений
  • payments - Платежи лида
    • category - Категория платежа
    • purpose - Назначение платежа
    • sum - Сумма платежа

Используется при: