Maintain your public APIs for the Postman API Network

If you prepared a team workspace for team collaboration, you can draft your next release there. Otherwise, you can update your changes in place in your public workspace.

To get started, open your team workspace and update your team collection. Your team collection is the fork of your public collection.

Update your public collections with a pull request

For these steps, you'll use Postman version control to update your public collection. You can draft your changes in your team workspace. When you're ready to share your changes with your API consumers, you can publish your changes to your public workspace by merging your pull request.

Create a pull request to merge to your public collection

To create a pull request to merge to your public collection, do the following:

1. Open your team workspace and the collection you updated.
2. Next to your collection, select View more actions. Then, select Create pull request.
3. Enter a title and description, and add reviewers.
4. Select Create Pull Request.

To learn more, see Create a pull request to contribute to an element you forked.

Review, approve, and merge the pull request to your public collection

To review, approve, and merge the pull request to your public collection, do the following:

1. Open your team workspace and the collection you updated.
2. From the Postman right sidebar, select Pull Requests.
3. Select the pull request's title.
4. Review the pull request's changes.
5. If you want to add a comment, from the Postman right sidebar, select Comments. Then, add a comment and select Comment.
6. If you approve the pull request, select Approve.
7. If the pull request is ready to merge, select Merge. Then, select how you want to merge and select Merge.

Postman merges your changes to your public collection and makes them available to your API consumers.

To learn more, see Review pull requests in Postman.

Update your public collections with the Postman API

For these steps, you'll use the Postman API to update your public collections. You can draft your changes in your team workspace. When you're ready to share your changes with your API consumers, you can publish your changes to your public workspace with a couple of API calls.

Create a new collection in your team workspace

Test your workflow in a Postman Collection first, before you integrate these steps in your continuous integration and continuous delivery (CI/CD) pipeline.

To create a new collection in your team workspace, open your team workspace, and, from the Postman sidebar, select Collections. Then, select Create new collection > Blank collection.

To learn more, see Create a new collection.

Save your collection IDs as variables

To save your collection IDs as variables, do the following:

1. Open your team workspace and the collection you updated.
2. From the Postman right sidebar, select Info.
3. Select Copy collection ID. Postman copies the collection ID to your clipboard.
4. Create a new variable and save the collection ID to it. Save it in your team workspace and name the variable something memorable, such as apiReferenceTeamCollectionId.
5. Open your public workspace and the collection you want to update, and save its collection ID to another variable. Save it in your team workspace and name the variable something memorable, such as apiReferencePublicCollectionId.

To learn more, see Store and reuse values using variables.

Get your collection with an API call

To get your collection with an API call, do the following:

1. Open your team workspace and the collection you created for this workflow.
2. Add a request to your collection.
3. Select GET and enter https://api.getpostman.com/collections/:collectionId.
4. Open the Params tab and, for the collectionId path variable, enter your team collection ID.
5. If you haven't already, open the Authorization tab and set up authentication and authorization.
6. Select Send.

Postman returns your team collection as a JSON object.

To learn more, see Get a collection.

Update your public collection with an API call

To update your collection with an API call, do the following:

1. Open your team workspace and the collection you created for this workflow.
2. Add a request to your collection.
3. Select PUT and enter https://api.getpostman.com/collections/:collectionId.
4. Open the Params tab and, for the collectionId path variable, enter your public collection ID.
5. If you haven't already, open the Authorization tab and set up authentication and authorization.
6. Open the Body tab and add the team collection JSON object from the previous procedure. Remember to remove any IDs from the object, such as _postman_id, id, and uid. You can automate this step with a script.
7. Select Send.

Postman updates your public collection and makes your changes available to your API consumers.

To learn more, see Replace a collection's data.