EditCollection#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно.

Метод предназначен для редактирования существующей коллекции: изменения названия, добавления и удаления продуктов.

Особенности работы метода

После редактирования коллекции её идентификатор (id) изменяется. Используйте newCollectionId из ответа для всех последующих операций с этой коллекцией.

Запрос#

Для редактирования коллекции требуется выполнить запрос по адресу:

POST

{{baseUrl}}/waInstance{{idInstance}}/editCollection/{{apiTokenInstance}}

Для получения параметров запроса idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

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

Параметр	Тип	Обязательный	Описание
collectionId	string	Да	Уникальный идентификатор редактируемой коллекции
name	string	Нет	Новое название коллекции
productIdsToAdd	array of strings	Нет	Массив идентификаторов продуктов, которые нужно добавить в коллекцию
productIdsToRemove	array of strings	Нет	Массив идентификаторов продуктов, которые нужно удалить из коллекции

Пример тела запроса#

{
  "collectionId": "25790827003925602",
  "name": "Home Essentials",
  "productIdsToAdd": ["26429381740022203"],
  "productIdsToRemove": ["25789428137398187"]
}

Ответ#

Поля ответа#

Поле	Тип	Описание
edited	boolean	Возвращает true, если редактирование прошло успешно
newCollectionId	string	Новый идентификатор отредактированной коллекции

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

{
  "edited": true,
  "newCollectionId": "2205593430194788"
}

Ошибки EditCollection#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Примеры кода#

PythoncURL

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/editCollection/{{apiTokenInstance}}"

payload = {
    "collectionId": "25790827003925602",
    "name": "Home Essentials",
    "productIdsToAdd": ["26429381740022203"],
    "productIdsToRemove": ["25789428137398187"]
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/editCollection/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collectionId": "25790827003925602",
    "name": "Home Essentials",
    "productIdsToAdd": ["26429381740022203"],
    "productIdsToRemove": ["25789428137398187"]
}'

Внимание

Организация Meta, а также её продукты Instagram и Facebook, на которые мы ссылаемся в этой статье, признаны экстремистскими на территории РФ.
WhatsApp* принадлежит компании Meta Platforms Inc., деятельность которой признана экстремистской и запрещена на территории Российской Федерации. На основании решения Тверского районного суда г.Москвы от 21.03.2022 и требований ст. 10 ФЗ-114 в отношении компании Meta Platforms Inc.