Edit Pull Request

Edit pull request properties (RESTful endpoint).

Update the state of a pull request (open, closed, draft, ready_for_review). This endpoint requires both repo_id and pr_id for RESTful compliance. The requesting user must have write permissions to the repository.

Rate limit: 30 requests per minute.

PATCH /v1/organizations/{org_id}/repos/{repo_id}/prs/{pr_id}

Edit Pull Request

cURL

curl --request PATCH \
  --url https://api.codegen.com/v1/organizations/{org_id}/repos/{repo_id}/prs/{pr_id} \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "success": true,
  "url": "<string>",
  "number": 123,
  "title": "<string>",
  "state": "<string>",
  "error": "<string>"
}

Headers

Path Parameters

org_id · integer · required

repo_id · integer · required

pr_id · integer · required

Body

application/json

Input for editing PR properties.

state · enum<string> · required

Available options: open, closed, draft, ready_for_review

Response

200

application/json

Successful Response

Response from editing PR properties.

success · boolean · required

url · string | null

number · integer | null

title · string | null

state · string | null

error · string | null