Запрос

POST /lead

Тело запроса

{
  "contact_id": contact_id,
  "name": "Name",
  "callback": true/false,
  "funnel": funnel_id,
  "lead_date": lead_create_date,
  "deal_date": deal_date,
  "view_id": 123,
  "view":
    {
        "source": "someSource",
        "campaign": "someCampaign",
        "keyword": "someKeyword"
    },
  "custom": 
    { 
        "custom_field_id": "custom_field_value"
    },
  "payments": [
    {
        "category": "someCategory",
        "purpose": "paymentPurpose",
        "sum": 123.12
    }
  ],
  "owner": lead_owner_id
}

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

  • contact_id (Обязательное) - id контакта
  • name - Имя лида
  • callback - Заказать обратный звонок (звонок начнётся сразу после создания лида)
  • funnel - id шага воронки
  • lead_date - Дата создания/регистрации лида. Формат d.m.Y H:i (23.12.2017 15:47)
  • deal_date - Дата платежа. Формат d.m.Y H:i (23.12.2017 15:47). Будет выставленно только если будет передан хотя бы один платёж
  • view_id - id просмотра
  • view - Данные просмотра. (Можно указать вместо view_id)
  • custom - Массив данных, которые необходимо записать в соответствующие кастомные поля
    • custom_field_id - id кастомного поля
    • custom_field_value - Значение, которое необходимо записать в поле
  • owner - Владелец лида (если значение "0", то владельцем становится главный аккаунт)
  • payments - Платежи лида (всегда передаётся массивом). При наличии платежей - лид попадёт в раздел сделки. Так же если не задан funnel - шаг будет выставлен "Оплата".
    • category - Категория платежа
    • purpose - Назначение платежа
    • sum - Сумма платежа

      Создать лида с шагом "Оплата" без платежей невозможно

Пример запроса

curl -H 'Content-Type: application/json' \
    -H 'token: someToken' \
    -X POST \
    -d '{"contact_id": 12345, "name": "TestLead", "callback": false, "source": "Api", "campaign": "CampaignName", "keyword": "keywordName", "funnel": 123}}' \
    direct.lptracker.ru/lead

Пример ответа при успешном выполнении:

{
  "status": "success",
  "result": {
    "id": 1234,
    "contact_id": 12345,
    "name": "TestLead",
    "view": {
      "id": 43,
      "source": "Api",
      "campaign": "CampaignName",
      "keyword": "keywordName"
    },
    "custom": [
      {
        "id": 124,
        "name": "Владелец заявки",
        "type": "owner",
        "value": {
          "id": 100,
          "type": "main"
        }
      },
      {
        "id": 125,
        "name": "Шаг воронки",
        "type": "funnel",
        "value": "123"
      }
    ]
  }
}

Описание модели лида