API Холодные контакты

Информация по работе с объектом Холодные контакты (leads).

Справочники
GET /statuses — Получение списка статусов холодных контактов.
GET /sources — Получение списка источников холодных контактов.
GET /custom_fields — Получение списка произвольных полей холодных контактов.

Операции
GET / — Получение списка холодных контактов.
GET /$id — Получение карточки холодного контакта.
POST / — Добавление холодного контакта.
PUT /$id — Обновление холодного контакта.
DELETE /$id — Удаление холодного контакта.

Поля
name — Название (Текст).
description — Описание (Текст).
phone — Телефон 1 (Текст).
phone2 — Телефон 2 (Текст).
phone3 — Телефон 3 (Текст).
phone4 — Телефон 4 (Текст).
phone5 — Телефон 5 (Текст).
email — Email 1 (Текст).
email2 — Email 2 (Текст).
email3 — Email 3 (Текст).
email4 — Email 4 (Текст).
email5 — Email 5 (Текст).
price — Сумма (Число).
currency — Валюта (Идентификатор валюты).
site — Сайт (Текст).
company — Организация (Идентификатор организации).
source — Источник (Идентификатор источника).
status — Статус (Идентификатор статуса).
city — Город (Текст).
region — Регион (Текст).
address — Адрес (Текст).
utm_campaign — UTM Campaign (Текст).
utm_content — UTM Content (Текст).
utm_medium — UTM Medium (Текст).
utm_source- UTM Source (Текст).
utm_term — UTM Term (Текст).
utm_age — UTM Age (Текст).
utm_geo — UTM Geo (Текст).
clientid — Client ID (Текст).
user — Ответственный (Идентификатор пользователя).

Фильтры
id - Идентификатор или массив идентификаторов.
name — Название.
phone — Телефон.
email — Почта.
user — Ответственный.
d_reg1 - Дата добавления (От).
d_reg2 - Дата добавления (До).
d_mod1 - Дата изменения (От).
d_mod2 - Дата изменения (До).

//Пример добавления холодного контакта с указанием UTM меток (utm_campaign, utm_content, utm_medium, utm_source, utm_term) на PHP

$apikey = "Ваш API-ключ";

$url = "https://wirecrm.com/api/v1/leads";

$headers = array("X-API-KEY:".$apikey);

$data = '{"name":"Игорь","phone":"79191122333","email":"test@test.com","description":"Новая заявка","utm_campaign":"kommercheskaya_nedvizhimost","utm_content":"1234567890","utm_medium":"cpc","utm_source":"yandex","utm_term":"kupit_odnokomnatnuju_kvartiru"}';

$handle = curl_init();

curl_setopt($handle, CURLOPT_URL, $url);

curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");

curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);

curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);

curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");

curl_setopt($handle, CURLOPT_POSTFIELDS, $data);

curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);

$data = curl_exec($handle);

curl_close($handle);

//Пример добавления холодного контакта с указанием статусы и источника на PHP

$apikey = "Ваш API-ключ";

//Список статусов холодных контактов

//Можно получить GET запросом https://wirecrm.com/api/v1/leads/statuses

$lead_status_id = "ID статуса";

//Список источников холодных контактов

//Можно получить GET запросом https://wirecrm.com/api/v1/leads/sources

$lead_source_id = "ID источника";

//Добавляем холодный контакт

$url = "https://wirecrm.com/api/v1/leads";

$headers = array("X-API-KEY:".$apikey);

$data = '{"name":"Игорь","phone":"79191122333","email":"test@test.com","description":"Новая заявка с сайта","status":"'.$lead_status_id.'","source":"'.$lead_source_id.'"}';

$handle = curl_init();

curl_setopt($handle, CURLOPT_URL, $url);

curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");

curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);

curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);

curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");

curl_setopt($handle, CURLOPT_POSTFIELDS, $data);

curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);

$data = curl_exec($handle);

curl_close($handle);