EditCollection#

Для работы с методом необходимо иметь WhatsApp* Business аккаунт.

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

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

Запрос#

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

{{apiUrl}}/waInstance{{idInstance}}/editCollection/{{apiTokenInstance}}

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

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

Поля name, productIdsToAdd и productIdsToRemove можно передавать в любом сочетании, но помимо collectionId должно быть указано хотя бы одно из них.

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

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

Ответ#

Поля ответа#

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

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

Ошибки EditCollection#

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

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

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"]
}'