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

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

issue_number Integer Yes

The number that identifies the issue.

owner String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
lock_reason String No

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

Possible values:

  • "too heated"
  • "resolved"
  • "spam"
  • "off-topic"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.