Create a pull request

POST

/collections/:collectionId/pull-requests

POST

/collections/:collectionId/pull-requests

$ curl -X POST https://api.postman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2/pull-requests \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Test PR",
>   "reviewers": [
>     "87654321",
>     "56781234"
>   ],
>   "destinationId": "12345678-ec548788-unftw-rgn8-83b8-0b59798648e4",
>   "description": "This is a test pull request."
> }'

1 {
2   "createdAt": "2024-02-20T09:55:46.000Z",
3   "createdBy": "12345678",
4   "description": "This is a test pull request.",
5   "destinationId": "12345678-ec548788-unftw-rgn8-83b8-0b59798648e4",
6   "id": "4e1a6609-1a29-4037-a411-89ecc14c6cd8",
7   "sourceId": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef",
8   "status": "open",
9   "title": "Test PR",
10   "updatedAt": "2024-02-20T09:58:57.000Z"
11 }

Creates a pull request for a forked collection into its parent collection.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

Request

This endpoint expects an object.

titlestringRequired

The title of the pull request.

reviewerslist of stringsRequired

A list of reviewers to assign to the pull request.

destinationIdstringRequired

The collection ID to merge the pull request into.

descriptionstringOptional

The pull request's description.

Response

Successful Response

createdAtstringOptional

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.

destinationIdstringOptional

The pull request's merge destination ID.

idstringOptional

The pull request's ID.

sourceIdstringOptional

The pull request’s source (parent) ID.

statusstringOptional

The pull request's current status.

titlestringOptional

The pull request's title.

updatedAtstringOptional

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

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error