Posts

Lock a post from being edited

PUT

https://discourse.example.com/posts/{id}/locked.json

curl -X PUT 'https://discourse.example.com/posts/string/locked.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "locked": "string"
}'

const body = `{
  "locked": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "locked": "string"
}'''

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

Request Body

{
  "locked": "string"
}

200

{
  "locked": true
}

Body

application/json

lockedstringrequired

Whether to lock the post (true/false)

Parameters

Api-Keystringrequiredheader

Api-Usernamestringrequiredheader

idstringrequiredpath

Response

200OKobject

post updated

Response fields application/json

lockedbooleanrequired

Whether the post is locked

Docs by Sourcey