DeleteCollection#

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

Метод предназначен для удаления коллекции из каталога.

Необратимость удаления

Удаление коллекции невозможно отменить. После удаления коллекции её идентификатор становится недействительным, но продукты из коллекции остаются в каталоге (сама коллекция удаляется).

Ограничения со стороны WhatsApp

WhatsApp* может временно ограничить доступ к Business Catalog API при частом обращении к методам каталогов.
Не выполняйте большое количество запросов к методам каталогов за короткий промежуток времени.

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/deleteCollection/{{apiTokenInstance}}

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

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

Параметр	Тип	Обязательный	Описание
`collectionId`	string	Да	Уникальный идентификатор удаляемой коллекции

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

{
  "collectionId": "984885117332518"
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`deleted`	boolean	Возвращает true, если удаление прошло успешно
`deletedCollectionId`	string	Идентификатор удалённой коллекции

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

{
  "deleted": true,
  "deletedCollectionId": "984885117332518"
}

Ошибки DeleteCollection#

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

Код HTTP	Идентификатор ошибки	Описание
400	`Catalog mutations require a business account`	Ограничение со стороны WhatsApp при частом обращении к методам каталогов. Возвращается, даже если запрос выполняется от Business-аккаунта

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

PythoncURL

import requests

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

payload = {
    "collectionId": "984885117332518"
}
headers = {
    'Content-Type': 'application/json'
}

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

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/deleteCollection/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collectionId": "984885117332518"
}'