curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'title=Новый заголовок' \
--data-urlencode 'sv_prefix_ids[]=1' \
'https://forum.arzguard.com/api/threads/123/'
{
"success": true,
"thread": {
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
}
Темы
Изменить тему
Редактирует заголовок, префиксы, состояние, теги и пользовательские поля темы.
POST
/
api
/
threads
/
{id}
/
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'title=Новый заголовок' \
--data-urlencode 'sv_prefix_ids[]=1' \
'https://forum.arzguard.com/api/threads/123/'
{
"success": true,
"thread": {
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
}
Редактирует заголовок, префиксы, состояние, теги и пользовательские поля темы.
Обязательные scopes:
Тело запроса:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
thread:write.
Особенности
Guard Forum использует MultiPrefix: передавайтеsv_prefix_ids[] либо запасной prefix_id[], а не скалярный prefix_id. В ответе объект темы содержит sv_prefix_ids — массив ID. Подробнее: расширения Guard Forum.
Параметры
integer
required
ID темы. Значение
123 в примере условное.string
Заголовок темы.
boolean
Открыта ли тема для ответов. Изменение применяется при наличии права закрывать и открывать тему.
boolean
Закрепить ли тему в разделе. Применяется при наличии соответствующего права.
string
Значение пользовательского поля с указанным именем. Замените
<name> реальным ключом, например custom_fields[example].array
Массив названий тегов для добавления. Передавайте как
add_tags[]; требуется право редактировать теги.array
Массив названий тегов для удаления. Передавайте как
remove_tags[]; требуется право редактировать теги.integer[]
Массив ID префиксов Guard Forum. Передавайте повторяющиеся
sv_prefix_ids[]. Имеет приоритет над запасным параметром prefix_id[]; применяются проверки доступности и лимитов префиксов.integer[]
Запасной массив ID префиксов, если
sv_prefix_ids не передан. Для создания и редактирования темы Guard Forum используйте массив, а не одиночное число.application/x-www-form-urlencoded. Данные передаются в UTF-8.
Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
success | true | true, если действие выполнено успешно. |
thread | Thread | Объект темы Thread. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'title=Новый заголовок' \
--data-urlencode 'sv_prefix_ids[]=1' \
'https://forum.arzguard.com/api/threads/123/'
{
"success": true,
"thread": {
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
}