Создание или изменение контакта — addupdatelead

Содержание

1 Как работает
2 Параметры передаваемые в запросе
3 Пример на PHP (cURL)
4 Postman (импорт коллекции Expertam API)

Как работает

Данная версия API доступна на тарифах «Эксперт» и «Гуру».

Если вы не разработчик, прочитайте эту статью, она значительно облегчит использование API 2.0.

Вы можете добавлять новые контакты в ваш аккаунт Expertam, формируя запрос к API сервиса программными методами.

Запрос передаётся методом POST в формате URLencode на адрес: https://username.expertam.ru/api/addupdatelead, где username — это логин пользователя в системе и его домен 3-его уровня в сервисе Expertam.

В ответ на запрос ваша система получит результат выполнения функции в формате JSON. Например, такой:

{"error_code":0,"error_text":"OK","result":[],"hash":"******************************"}

1	{"error_code":0,"error_text":"OK","result":[],"hash":"******************************"}

Подробнее смотрите «Ответы API сервиса».

Параметры передаваемые в запросе

Параметры запроса следующие, обязательным параметром является «rps_key» — ваш ключ API:

rpsKey — ключ API; ключ для вашего аккаунта находится в разделе «Интеграция и API», ссылка на раздел находится в футере личного кабинета или вот /shops/setts/apisettings/
add_to_lists — в какие группы добавлять контакт; строка, указываются ID групп(ы), через запятую (редактирование группы => вкладка API, например 1473249885.2899961004)
remove_from_lists — из каких групп удалять контакт; строка, указываются ID групп(ы), через запятую (редактирование группы => вкладка API, например 1473249885.2899961004)
add_tags — какие теги добавить контакту; строка; теги через запятую
remove_tags — какие теги удалить у контакта; строка; теги через запятую (удаление тегов контакта)
lead_email — email контакта (если не указан, будет создан без емейла); строка
lead_first_name — имя контакта; строка
lead_middle_name — отчество контакта; строка
lead_last_name — фамилия контакта; строка
lead_phone — телефон контакта; строка
lead_utc — часовой пояс контакта (UTC+03, +03, -01, 3, -1); строка
lead_description — информация о клиенте, видна в карточке контакта; строка
lead_personal_manager — id персонального менеджера для контакта (id берется из ссылки редактирования сотрудника /shops/access/)
lead_shipping_address_1 — адрес доставки, виден в карточке контакта; строка
lead_shipping_address_2 — адрес доставки (рекомендуется использовать как дополнительное поле в случае сложных адресов), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_shipping_city — адрес доставки (рекомендуется использовать для города), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_shipping_zip — адрес доставки (рекомендуется использовать для индекса), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_shipping_country_code — код страны доставки; строка; передавать в формате [ISO country codes] (ex. «US»,»CA» etc), в карточке контакта автоматически заменится на страну (например, «US» станет «Соединенные Штаты Америки»)
lead_shipping_state — адрес доставки (рекомендуется использовать для области/штата), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_address_1 — адрес для выставления счета (рекомендуется использовать для индекса), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_address_2 — адрес для выставления счета (рекомендуется использовать как дополнительное поле в случае сложных адресов), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_city — адрес для выставления счета (рекомендуется использовать для города), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_state — адрес для выставления счета (рекомендуется использовать для области/штата), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_zip — адрес для выставления счета (рекомендуется использовать для индекса), виден в карточке контакта, будет указан через запятую после предыдущего адреса; строка
lead_billing_country_code — код страны для выставления счета; строка; передавать в формате [ISO country codes] (ex. «US»,»CA» etc), в карточке контакта автоматически заменится на страну (например, «US» станет «Соединенные Штаты Америки»)
lead_facebook — id контакта в Facebook*; строка
lead_instagram — id контакта в Instagram*; строка
lead_whatsapp — id контакта в Whatsapp; строка
lead_telegram — id контакта в Telegram; строка
lead_viber — id контакта в Viber; строка
lead_vkontakte — id контакта в Вконтакте; строка
lead_in — id контакта в LinkedIn; строка

Также данный метод умеет работать с дополнительными полями, которые вы можете создавать в CRM. *Facebook/Instagram, продукт компании Meta, которая признана экстремисткой организацией в России.

Чтобы изменить значение дополнительного поля, передайте значение параметра

ex_fields[3]

где «3» — это id дополнительного поля. Взять его можно в колонке «id», для дополнительных полей CRM

Пример на PHP (cURL)

<?php 
  $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://username.expertam.ru/api/addupdatelead',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('rpsKey' => 'Подставьте ваш ключ апи вместо этого значения.','lead_email' => 'test@expertam.ru','add_to_lists' => '1594725950.5982672784,1605870811.1867176380','remove_from_lists' => '1534723950.5982672783','add_tags' => 'tag2020'),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
 
?>

<?php

$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://username.expertam.ru/api/addupdatelead',

CURLOPT_RETURNTRANSFER => true,

CURLOPT_ENCODING => '',

CURLOPT_MAXREDIRS => 10,

CURLOPT_TIMEOUT => 0,

CURLOPT_FOLLOWLOCATION => true,

CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

CURLOPT_CUSTOMREQUEST => 'POST',

CURLOPT_POSTFIELDS => array('rpsKey' => 'Подставьте ваш ключ апи вместо этого значения.','lead_email' => '[email protected]','add_to_lists' => '1594725950.5982672784,1605870811.1867176380','remove_from_lists' => '1534723950.5982672783','add_tags' => 'tag2020'),

));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

Postman (импорт коллекции Expertam API)

У вас установлен Postman? Тогда вы можете импортировать всю коллекцию API по этой ссылке: https://www.getpostman.com/collections/9d1c9b989f68a5ac0f75

Для этого нужно:

В вашем Postman клиенте нажать на кнопку «Import»
Выбрать вкладку «Import from link»
Ввести ссылку на нашу коллекцию https://www.getpostman.com/collections/9d1c9b989f68a5ac0f75
Нажать на кнопку «Import»

Как работает

Параметры передаваемые в запросе

Пример на PHP (cURL)

Postman (импорт коллекции Expertam API)

Статьи по теме:

Что, если я не программист? (API 2.0)

Получение списка всех купонов (скидок) — getcoupons

Получение списка продуктов — getgoods

Получение списка групп (подписки) — getalllists

Получить список дополнительных сотрудников — getpersonalmanagers

Создание счета — createorder

Оценить статью