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