Announce API changes in your team workspace

You can post updates in team workspaces to tell consumers of your APIs about changes you’ve made to your API. Workspace updates enable seamless collaboration by allowing other Postman users to directly react and respond to your API changes in the same context where the changes occur.

When you create a workspace update, you can give it a title and a description. You can also add a tag, links to collections, requests, saved examples, and a change summary. Consumers who are watching the workspace will be notified when you post an update, and they can react and add comments to it. Workspace updates are a convenient source of truth for your APIs that facilitate collaborative discussion within the workspace itself.

Updates appear under the Updates tab next to the workspace’s Overview tab. Users with the Workspace Admin or Workspace Editor role can post and edit workspace updates.

Post a workspace update

To post a workspace update, do the following:

  1. Open a workspace and select Updates.
  2. Select Post an Update.
  3. Enter a title and a description of your update.
  4. (Optional) Select a tag from the dropdown list.
  5. (Optional) Select Link Resource to include links to collections, requests, and saved examples in your update.
  6. Select Post Update.

Share, edit, or delete a workspace update

To share, edit, or delete the update, do the following:

  1. Open a workspace and select Updates.
  2. Select the more actions icon More actions icon.
  3. Select Copy link, Edit, or Delete.

Last modified: 2024/04/29