Commenting on collections

You can leave comments on collections and requests to collaborate with your teammates. You can tag your collaborators in comments to let them know that you have questions or feedback.

Contents

The Postman app only supports comments on requests. To leave or read comments on a collection, open the Postman Dashboard in your web browser.

Commenting on a collection

You can leave comments on collections from the Postman Dashboard.

Team members must have access to the collection in question in order to post comments.

  1. Sign in to the Dashboard.
  2. At the top, select a Workspace and then click the Collections tab.
  3. Open the collection you want to leave your comment on and click Comments on the right.

Comment UI

Commenting on a request

You can comment on requests from the Postman Dashboard or in the Postman app. When you comment on a request, it's reflected in both the Dashboard and the app.

You can only post comments on saved requests.

  1. From the Postman app or Dashboard, open the collection with the request you want to comment on.
  2. At the top right, click Comments.

    • You'll also see any other comments on the request.

Comments in app and dashboard

You'll get a notification if you get tagged in a comment. If you don't have access to the collection you've been tagged on, you'll need to request access before you can read the comment.

Reading comments

You can see comments made by teammates on requests and collections in the Postman app or the Dashboard.

Reading comments in the Postman app

  1. In the Postman app, open the request that has the comments you want to review.
  2. At the top, click Comments.

The comment button displays the number of existing comments.

Reading a comment

Reading comments on the Dashboard

You can read the comments on a collection through the Postman Dashboard.

  1. Sign in to the Dashboard.
  2. At the top, select a Workspace and then click the Collections tab.
  3. Open the collection with the comments you want to read.
  4. Next to the request with the comments you want to see, click Comments.

    • Any comments posted on the collection as a whole will be next to the collection name.

read comment collection dashboard

Editing comments

You can make changes to comments you've already posted. Other team members cannot edit your comments.

  1. In the Postman app or Dashboard, find the collection with the comment you want to edit.
  2. Find the comment and click Comment > Edit.

Edit comment

Deleting comments

  1. In the Postman app or Dashboard, find the collection with the comment you want to delete.
  2. Open the comment and click Comments > Delete.

Delete comment

For moderation purposes, admins can delete comments made by anyone, but cannot modify comments.

Tagging members in comments

When you leave feedback or a question for a specific teammate, you can let them know by tagging them in your comment.

  1. In the Postman app or Dashboard, open the collection or request you want to leave your comment on.
  2. Click Comments and write your message.
  3. To tag your teammate, type "@" and choose their name from the list.
  4. Click Add comment.

Your teammate will be notified in the app or with an email that they've been tagged in a comment. In-app notifications appear as a red dot above the bell icon at the top right.

If your teammate has disabled notifications then they will not be notified.

Notification bell

Next steps

Postman comments support Markdown. For more information on formatting using Markdown refer to Markdown in API Documentation.