POST /lead — Создать лид

Обновлено 23 марта 2025 г.

POST https://{idcrm}-crm-api.vionvi.com/lead

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8.

Параметры запроса:

Параметр	Тип данных	Обязательно	Описание
clientId	int	+	ID Клиента
sourceId	int	+	ID Источника
userIdOwner	int	-	ID Ответственного
funnelStageId	int	-	ID Этапа воронки
locationUnitId	int	-	ID Офиса
locationCityId	int	-	ID Города
cost	int	-	Сумма (Бюджет)
utmSource	string	-	UTM Source
utmMedium	string	-	UTM Medium
utmCampaing	string	-	UTM Campaing
utmContent	string	-	UTM Content
utmTerm	string	-	UTM Term
utmReferrer	string	-	UTM Referrer
openstatService	string	-	Openstat Service
openstatCampaing	string	-	Openstat Campaing
openstatAd	string	-	Openstat Ad
openstatSource	string	-	Openstat Source
from	string	-	Метка From
yclid	string	-	Метка Яндекс.Директ
ymclid	string	-	Метка Яндес.Маркет
ymClientId	string	-	Client ID Яндекс.Метрика
yqrid	string	-	Метка Яндекс QR
gclid	string	-	Метка Google Adwords
fbclid	string	-	Метка Facebook
roistatId	string	-	ID Roistat
referrer	string	-	Источник перехода
ip	string	-	IP Адрес

Пример запроса с перечислением параметров:

{
  "clientId": 1234,
  "sourceId": 2,
  "userIdOwner": 1,
  "utmSource": "Yandex",
  "utmMedium": "cpc",
  "utmCampaign": "promo",
  "utmContent": "link",
  "utmTerm": "free",
  "referrer": "https://site.ru"
}

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса. Ответ от сервера приходит в формате JSON и кодировке UTF-8. При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data. При ошибке выполнения запроса вы можете получить в теле ответа массив errors.

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

201 Created
Content-Type: application/json
{
  "data": {
    "id": 50,
    "clientId": 1234,
    "sourceId": 8,
    "notAnswer": null,
    "userIdCreate": null,
    "userIdUpdate": null,
    "dtCreate": 1690290640,
    "dtUpdate": 1690290640,
    "dtNotAnswer": null,
    "locationUnitId": null,
    "locationCityId": null,
    "funnelStageId": null,
    "userIdOwner": 1,
    "otherCount": 0,
    "cost": null,
    "remoteId": null,
    "utmSource": null,
    "utmMedium": null,
    "utmCampaign": null,
    "utmContent": null,
    "utmTerm": null,
    "utmReferrer": null,
    "openstatService": null,
    "openstatCampaign": null,
    "openstatAd": null,
    "openstatSource": null,
    "from": null,
    "yclid": null,
    "ymclid": null,
    "ymClientId": null,
    "gclid": null,
    "yqrid": null,
    "fbclid": null,
    "roistatId": null,
    "referrer": null,
    "ip": null
  }
}

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


422 Unprocessable Content
Content-Type: application/json
{
  "errors": {
      "clientId": [
          "Поле Клиент обязательно для заполнения."
      ]
  }
}

POST /lead — Создать лид

Ещё в разделе