Lock an issue

PUT

/repos/{owner}/{repo}/issues/{issue_number}/lock

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."

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///issues//lock' \
--header 'Content-Type: application/json' \
--data-raw '{
    "lock_reason": "off-topic"
}'

Response Example

204 - Example 1

{}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

issue_number

integer

required

The number that identifies the issue.

Body Params application/json

object | null

optional

lock_reason

enum<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 values:

off-topictoo heatedresolvedspam

Examples

Responses

🟢204Response

application/json

Body

object {0}

🟠403403

🟠404404

🟠410410

🟠422422

Modified at 2023-08-15 02:59:27

Unlock an issue

List timeline events for an issue