Commenting on collections

Postman provides a quick way to collaborate with your team members by allowing you to post comments on collections and requests. This is an easy way to provide valuable feedback to your team members on your collections and requests.

This topic describes the following sections:

Posting comments

Notes:

  • Postman app currently supports comments on requests only.
  • Team members must have access to the collection in question in order to post comments.
  • You can only post comments on saved requests.

Posting comments on a collection

You can leave a comment on a collection through the Postman Dashboard. To post a comment on a collection, navigate to the Collections tab at the top of the page, select the collection you want to leave a comment on, then click Comments.

comment collection

Posting comments on a request

You can comment on requests via the web dashboard or the Postman app. When you comment on a request, it is reflected in both the Dashboard and the app.

To post a comment, select the corresponding request and click Comments. Write your comment, then click Add Comment to publish. The procedure to post a comment is similar in the Postman app and the dashboard.

post comments

If someone tags you in a comment on a private collection that you don’t have access for, Postman sends a notification to you. However, you can’t read the comment until the collection or the request is shared with you.

Reading comments

You can see comments made by teammates on requests and collections with the Postman app or the web dashboard.

Reading comments on the Postman app

To review comments, navigate to the request in question and click Comments to view all comments associated with the request.

The comment button displays the number of existing comments between brackets.

read comments app

Reading comments on the Postman dashboard

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

To read the comments on a collection, navigate to the Collections tab at the top of the page, select the collection in mind, then click Comments.

read comment collection dashboard

To read the comments on a specific request, navigate to the Collections tab at the top of the page, select the collection to which the request belongs, select the request, then click Comments.

read comment request dashboard

Editing comments

After posting a comment, you can go back, edit your comment and save your changes. Only you as a creator of the comment will be able to update/modify your comment.

edit comments

Deleting comments

You can delete your comments by clicking delete:

delete comments

For moderation purposes, Admins can delete anyone’s comment. However, admins will not be able to update/modify a comment.

Tagging members in comments

Sometimes you may want to call the attention of a team member when posting a comment. In such a scenario, you can tag a person by typing the @ symbol followed by the member’s name and then choosing the corresponding name from the auto-suggested list. When you tag a member in your comment, Postman notifies the member by sending a notification.

post comments

The user tagged in your comment will get a notification by email and/or in-app as long as they have not disabled these types of notifications. The notifications in-app are shown at the top-right on the bell icon. To navigate to the comment, the recipient can click the collection name.

receive comment

Markdown support

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

post comments