curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'message=Обновлённый текст' \
'https://forum.arzguard.com/api/posts/123/'
{
"success": true,
"post": {
"post_id": 123
}
}
Сообщения
Изменить сообщение
Редактирует текст, вложения и отметку редактирования сообщения.
POST
/
api
/
posts
/
{id}
/
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'message=Обновлённый текст' \
'https://forum.arzguard.com/api/posts/123/'
{
"success": true,
"post": {
"post_id": 123
}
}
Редактирует текст, вложения и отметку редактирования сообщения.
Обязательные scopes:
Тело запроса:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
thread:write.
Параметры
integer
required
ID сообщения. Значение
123 в примере условное.string
Текст сообщения. Проверяется правилами и ограничениями выбранного типа содержимого.
boolean
При
1 и наличии соответствующего права не добавляет отметку «последнее редактирование».boolean
При
1 и наличии права удаляет прежнюю отметку редактирования. Требует также silent=1.boolean
При
1 отправляет автору уведомление о действии, если отправка разрешена для этого содержимого.string
Пояснение к уведомлению автору; используется вместе с
author_alert.string
Ключ подготовленных вложений с типом
post и контекстом context[post_id], равным ID редактируемого сообщения.application/x-www-form-urlencoded. Данные передаются в UTF-8.
Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
success | true | true, если действие выполнено успешно. |
post | Post | Созданное, изменённое или запрошенное сообщение Post. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request POST \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
--data-urlencode 'message=Обновлённый текст' \
'https://forum.arzguard.com/api/posts/123/'
{
"success": true,
"post": {
"post_id": 123
}
}