You can contribute to a collection or environment you forked with a pull request (Postman Flows doesn't support this feature). When you create a pull request, you ask others to review your changes to the element you forked. These reviewers can add comments to the request and approve your changes before your merge them. This is an example of version control.
By default, approvals are optional. If you're on the Postman Professional or Enterprise plan, you can make approvals required.
You can create a pull request to merge changes made in a forked collection or environment.
Reviewers must be able to access the source element to review your pull request. If the parent element is in a public workspace that's not in your Postman team, you must move the source element to a public workspace. You'll be notified if reviewers can't access the source element when you create a pull request. In the notification, you can select Move Collection or Move Environment to move the source element to a public workspace.
To create a pull request, do the following:
Hover over the element in the sidebar.
Select the more actions icon next to its name.
Select Create pull request.
Select Changes to review the changes in the pull request.
If the parent element has any changes since you last updated your fork, you can pull those changes into your fork before merging.
If there are any conflicts between the fork and the parent element, Postman highlights them so you can resolve them.
Select Overview, and enter a title and description for your pull request.
Select up to 50 reviewers or user groups from the dropdown list. Reviewers and user groups must have Editor access for the parent element to merge your changes.
Select Create Pull Request.
Postman notifies the reviewers you selected about your pull request. You will receive a notification if the reviewers comment on, approve, or merge the pull request.
A reviewer or group must have the Editor role for the element to merge changes. If you add a user or group that doesn't have Editor access as a reviewer, there will be a warning icon next to the name. Reviewers and groups with the Viewer role can approve PRs, but can't merge PRs.
Pull request settings are available on Postman Professional and Enterprise plans.
Pull request settings let you manage permissions for reviewers and assign merge checks.
Hover over the element in the sidebar.
Select the more actions icon next to its name.
Select Manage roles.
Select Editor for the users and groups you want to give Editor access to.
Select Update Roles.
For collections, you can assign merge checks before approving changes.
There are two different types of checks that you can enable for a pull request:
To set merge checks for pull requests on a specific collection, do the following:
If the merge conditions for a pull request aren't met, the option to Merge it into the parent collection will be inactive.
For information about the pull request's merge conditions, select View Merge Conditions.
Last modified: 2024/09/04
Additional resources
Videos
Blog posts
Case Studies