Update a pull request

PUT

/pull-requests/:pullRequestId

PUT

/pull-requests/:pullRequestId

$ curl -X PUT https://api.postman.com/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Updated PR title",
>   "reviewers": [
>     "12345678",
>     "87654321"
>   ],
>   "description": "Updated description of the pull request."
> }'

1 {
2   "createdAt": "2024-02-20T09:58:57.000Z",
3   "createdBy": "12345678",
4   "description": "Updated description of the pull request.",
5   "destinationId": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
6   "forkType": "collection",
7   "id": "4e1a6609-1a29-4037-a411-89ecc14c6cd8",
8   "sourceId": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef",
9   "status": "open",
10   "title": "Updated PR title",
11   "updatedAt": "2024-02-20T09:58:57.000Z"
12 }

Updates an open pull request.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

pullRequestIdstringRequired

The pull request's ID.

Request

This endpoint expects an object.

titlestringRequired

The pull request's updated title.

reviewerslist of stringsRequired

An updated list of the pull request's assigned reviewers. This replaces all existing users assigned to the pull request with those you pass in the request body.

descriptionstringOptional

The updated pull request description.

Response

Successful Response

createdAtdatetimeOptional

The date and time at which the pull request was created.

createdBystringOptional

The ID of the user who created the pull request.

descriptionstringOptional

The pull request's description.

destinationIdstringOptionalformat: "uid"

The pull request's merge destination ID.

forkTypestringOptional

The type of forked element.

idstringOptional

The pull request's ID.

sourceIdstringOptionalformat: "uid"

The unique ID of the source element.

statusenumOptional

The pull request's status.

titlestringOptional

The pull request's title.

updatedAtdatetimeOptional

The date and time at which the pull request was updated.

Errors

403

Forbidden Error

409

Conflict Error

500

Internal Server Error