Метод createLeads

Метод позволяет добавлять сделки из Joomla в аккаунт AmoCRM пакетно.

Реализуемый метод API

POST /api/v4/leads

Официальная документация метода

Описание

Метод позволяет добавлять сделки в аккаунт пакетно.

Ограничения

Метод доступен в соответствии с правами пользователя.

Пакетные методы REST API AmoCRM позволяют добавлять за 1 раз не более 50 элементов. В контексте данного метода - не более 50 сделок.

Параметры

Name	Type	Description
`$data`	array	Массив данных сделки AmoCRM согласно официальной докуметации метода.

Возвращаемые значения

HTTP 200 Успешный ответ

Возвращаемое значение соответствует документации AmoCRM для этого метода.

Пример ответа

stdClass Object
(
    [_links] => stdClass Object
        (
            [self] => stdClass Object
                (
                    [href] => https://yoursubdomain.amocrm.ru/api/v4/leads
                )

        )

    [_embedded] => stdClass Object
        (
            [leads] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 20534409
                            [request_id] => 0
                            [_links] => stdClass Object
                                (
                                    [self] => stdClass Object
                                        (
                                            [href] => https://yoursubdomain.amocrm.ru/api/v4/leads/20534409
                                        )

                                )

                        )

                )

        )

)

HTTP 40x Неудачный ответ

Официальная документация говорит о возможном коде ответа 401 Пользователь не авторизован. Библиотека WT Amocrm возвращает объект ошибки следующей структуры:

stdClass Object
(
    [error_code] => 400
    [error_message] => createLeads function: Error while trying to create lead in Amo CRM. Amo CRM API response: request_id: 0
code: NotSupportedChoice
path: pipeline_id
detail: The value you selected is not a valid choice.
title: Bad Request
type: https://httpstatus.es/400
status: 400
detail: Request validation failed

)

Пример использования в коде

use Webtolk\Amocrm\Amocrm;

$amocrm = new Amocrm();
$leads = [];
$order_summ = 15453.44; // Сумма, бюджет сделки.
$lead_data = [
	'created_by'  => 0, //ID пользователя, создающий сделку. При передаче значения 0, сделка будет считаться созданной роботом. Поле не является обязательным
	'name'        => 'Заказ #2987427', // отображаемое название сделки
	'pipeline_id' => 3753682, // id воронки. Список воронок получаем методом getLeadsPiplines()
	'price'       => (int) $order_summ, // Amo CRM принимает здесь только целочисленные значения. Если нужны суммы с точностью до копейки - передаем их дополнительно в поля или примечание.
];

$lead_data['_embedded']['contacts'] = array();

/**
 * Массив данных контакта добавляется как вложенная сущность.
 */
$contact_id = 32942695; // id контакта. Ищем и получаем методом getContacts.
$contact = [
	'id' => $contact_id,
	'is_main' => true,
];
$lead_data['_embedded']['contacts'][] = $contact;
$leads[] = $lead_data;
	
$result_amo_crm = $amocrm->createLeads($leads);