Create a pull request

POST {{baseUrl}}/collections/{{collectiondUid}}/pull-requests

Creates a pull request for a forked collection into its parent collection. Include the following in the request body:

  • title — (Required) A string that contains the title of the pull request.

  • reviewers — (Required) An array of strings that contains a list of the pull request's assigned reviewers.

  • destinationId — (Required) A string that contains the collection ID to merge the pull request into.

  • description — (Required) A string that contains a description of the pull request.

Request Body

{"title"=>"{{pullRequestTitle}}", "description"=>"{{pullRequesetDescription}}", "reviewers"=>["{{userId}}", "{{userId}}"], "destinationId"=>"{{destinationCollectionId}}"}

RESPONSES

status: OK

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