Topics

Update the status of a topic

PUT

https://discourse.example.com/t/{id}/status.json

curl -X PUT 'https://discourse.example.com/t/string/status.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "status": "closed",
  "enabled": "true",
  "until": "2030-12-31"
}'

const body = `{
  "status": "closed",
  "enabled": "true",
  "until": "2030-12-31"
}`;

const response = await fetch('https://discourse.example.com/t/string/status.json', {
  method: 'PUT',
  headers: {
    'Api-Key': 'string',
    'Api-Username': 'string',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "status": "closed",
  "enabled": "true",
  "until": "2030-12-31"
}'''

response = requests.put(
    'https://discourse.example.com/t/string/status.json',
    data=body.encode('utf-8'),
    headers={
        'Api-Key': 'string',
        'Api-Username': 'string',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "status": "closed",
  "enabled": "true",
  "until": "2030-12-31"
}

200

{
  "success": "OK",
  "topic_status_update": "string"
}

Body

application/json

statusstringclosedpinnedpinned_globallyarchivedvisiblerequired

enabledstringtruefalserequired

untilstring

Only required for pinned and pinned_globally

Example

2030-12-31

Parameters

idstringrequiredpath

Response

200OKobject

topic updated

Response fields application/json

successstring

Example

OK

topic_status_updatestring | null

Docs by Sourcey