Topics

Update the status of a topic

Changed on
put/t/{id}/status.json

Request

  • Base URL
    https://discourse.example.com
  • Auth
    none declared. Required headers: Api-Key, Api-Username

Path parameters

idstring required

Headers

Api-Keystring required
Api-Usernamestring required

Request body

status'closed' | 'pinned' | 'pinned_globally' | 'archived' | 'visible' required
enabled'true' | 'false' required
untilstring

Only required for pinned and pinned_globally

Example request

{
  "until": "2030-12-31"
}

Response

topic updated

successstring
topic_status_updatestring nullable

Example response

{
  "success": "OK"
}

Changes