curl --request DELETE 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"success": true
}
Личные диалоги
Убрать переписку из списка
Убирает переписку из списка текущего пользователя, сохраняя её для остальных участников.
DELETE
/
api
/
conversations
/
{id}
/
curl --request DELETE 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"success": true
}
Убирает переписку из списка текущего пользователя, сохраняя её для остальных участников.
Это удаление из личного списка, а не физическое удаление всей переписки. Остальные участники сохраняют доступ. Без
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
ignore=1 новый ответ может вернуть переписку в список текущего пользователя.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: conversation:write. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
required
Идентификатор переписки.
boolean
При
1 игнорирует дальнейшие ответы. При 0 новый ответ может вернуть переписку в список.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
true
Результат выполнения операции.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request DELETE 'https://forum.arzguard.com/api/conversations/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"success": true
}