Communicate API changes using workspace updates

Workspace updates keep your team and your users aware of your API changes. API publishers can share updates across multiple collections, with links to the resources that changed. API consumers who fork or watch a workspace get notified and can engage with these updates by visiting, commenting, and reacting.

Workspace updates are available in team and public workspaces. Users with the Workspace Admin or Workspace Editor role can post and edit workspace updates.

Find the Updates tab at the workspace level, between the Overview and the Settings tabs.

When you create a workspace update, give it a title and description. Then, add a tag for the type of change you've made. It is optional but recommended that you include links to updated collections, requests, or saved examples, and a change summary.

Post a workspace update

To post a workspace update, do the following:

Open a workspace and select Updates.
If this is the first update, select Post an Update. Otherwise, you'll see a Post an update field above other updates.
Enter a title and a description of your update.
Select a tag from the dropdown list: Improvement, New Feature, Bug Fix, Breaking Change, or Announcement.
(Optional but recommended) Select Link Resource to include links to collections, requests, and saved examples in your update.

When you add links to collections or requests, the watchers of the collections, who may not be watching the workspace, also get notified about the update alongside workspace watchers.
(Optional) Add a summary describing the change.
Select Post Update.