Как добавить Тег к сделке AMO CRM по API?

Question

[Elena_11]

Как я могу корректно добавить тег к сделке в AMO CRM?
Заявка уходит, но не могу найти пример добавления тега по API. По документации пробую таким методом:

$tag = "Пример тега";
			
$response = $amoClient('POST', "/api/v4/leads/{$response['content'][0]['id']}", [
    [
        'tags' => [
            'name' => $tag
        ]
    ]
]);

В чём моя ошибка?

Answer 1

[Валерий Чмых]

Как уже вам ответили, для редактирования сделки нужен метод PATCH, а не POST
С отвечающим на счет эндпоинта не согласен, для изменения конкретной сделки у вас все верно
Сейчас лучше использовать параметр tags_to_add, а не _embedded['tags']

$tag = "Пример тега";
			
$response = $amoClient('PATCH', "/api/v4/leads/{$response['content'][0]['id']}", [
    [
        'tags_to_add' => [
           ['name' => $tag]
        ]
    ]
]);

Comments

[Михаил Р.]

Валерий Чмых

Сейчас лучше использовать параметр tags_to_add, а не _embedded['tags']

Откуда информация? В руководстве ничего не сказано про tags_to_add.

[Валерий Чмых]

Михаил Р., это указанно в доке по созданию/редактированию сделок/контактов/компаний/покупателей.
А почему лучше его использовать написано в чейнжлоге от 25 марта 2024

[Elena_11]

спасибо, там действительно метод PATCH, если отправлять отдельным запросом. Но как оказалось, тег можно сразу при создании сделки прописать, я почему-то решила, что отдельным запросом надо, как примечание) можно просто внутрь "_embedded" добавить, а метод у меня такой $amoClient('POST', '/api/v4/leads/complex',

"_embedded" => [
    'tags' => [
        ['name' => $tag],
    ],
],

[Валерий Чмых]

Elena_11, опять же, лучше используйте tags_to_add; его можно и при создании использовать

[Elena_11]

Валерий Чмых, да вроде работает и в документации у них указан 'tags', видимо можно и так и так. Раз работает)

Answer 2

[Михаил Р.]

- Не POST, а PATCH.
- Эндпоинт можно без id сделки: /api/v4/leads.
- Теги передаются как массив объектов внутри _embedded['tags'].
- Данные необходимо преобразовать в json.

Выглядеть это будет примерно так (я не силен в php):

$data = [
    [
        'id' => (int)$leadId,
        '_embedded' => [
            'tags' => [
                ['name' => 'tag_name'],
            ],
        ],
    ],
];

$res = $amoClient('PATCH', '/api/v4/leads', ['json' => $data]); 
echo $res['status'];