Удалить тег диалога

Удаляет тег диалога.

URL

DELETE https://api.carrotquest.io/conversations/{id}/tag

В качестве {id} нужно использовать ID диалога.

Параметры

Параметры аутентификации.
Параметр id_as_string.

Параметр	Тип	Описание
tag	строка[1;255]	Название тега. Строка от 1 до 255 символов
from_admin	Optional[ID/default_admin]	Укажите ID администратора, ставящего или удаляющего тег, или default_admin для отправки от имени дефолтного отправителя сайта
random_id	Optional[integer]	Случайное целое число, чтобы сопостовлять создаваемое сообщение с репликой из RTS. По умолчанию, 0

Замечания

Чтобы контролировать, кто удаляет тег, используйте параметр from_admin.

random_id используются для сопоставления реплики, пришедшей через Realtime services. Вы можете записать сюда случайное 32-битное число, которое придет в поле random_id объекта ConversationPart, созданного этим запросом. В этом случае нельзя использовать ID реплики, поскольку Realtime services работают асинхронно и сообщение туда может прийти раньше, чем вы получите ответ на запрос создания реплики. А может и наоборот. Порядок не определен.

Ответ

В поле data будет возвращен словарь, содержащий:

• id: ID - идентификатор созданной системной реплики назначения
• part_group: ID - идентификатор вопроса, к которому принадлежит новая реплика

Пример:

{
  "data": {
    "id": 123,
    "part_group": 345
  },
  "meta": {
    "status": 200
  }
}

Ошибки

Стандартные ошибки Web API.

Ошибки данного метода

Ошибка	Код	Описание
ConversationTagIsNotAssigned	400	Если при удалении тэг не присвоен диалогу

Примеры

Удалить тег mytag диалогу с ID=716 от имени администратора с ID=912:

curl -X DELETE \
  -H "Authorization: Token XXX" \
  --data-urlencode 'tag=mytag' \
  --data-urlencode 'from_admin=912' \
  'https://api.carrotquest.io/conversations/716/tag'