Skip to main content
Manja / GitHub

Lock an issue

Users with push access can lock an issue or pull request's conversation. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs)."

PUT/repos/{owner}/{repo}/issues/{issue_number}/lock
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
issue_number integer
required

issue_number parameter

Body Params
optional
application/jsonobject
lock_reason string
optional

The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \* `off-topic` \* `too heated` \* `resolved` \* `spam`

Allowed: "off-topic""too heated""resolved""spam"

Responses

Response

application/json Basic Error object

Forbidden

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Basic Error object

Gone

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Validation Error object

Validation failed

documentation_url string
required
errors array[object]
optional
items object
code string
required
field string
optional
index integer
optional
message string
optional
resource string
optional
value
optional
message string
required