Comment on collections, folders, and requests

Use comments to discuss your work with your teammates in Postman. You can add comments to collections, folders, requests, examples, and pull requests. Reply to a comment to keep the discussion going, or resolve a comment if it's been addressed. If you have questions or feedback, you can let your teammates know by mentioning them in your comments.

You can also add comments to APIs and API definitions in Postman. Learn more about commenting on APIs.

Contents

Add comments

You can add comments to a collection in Postman. You can also add comments to folders, requests, examples, or pull requests in collections. When you add a comment, Postman notifies other collection contributors about your comment.

You must have access to a collection to add comments to it.

To add a comment to a collection, folder, request, example, or pull request, do the following:

  1. Select Collections in the sidebar and select the collection, folder, request, example, or pull request you want to comment on.

  2. Select the comments icon Comments icon in the right sidebar and enter your comment.

    Postman supports Markdown in comments. See the Markdown Cheatsheet on GitHub for tips on formatting.

  3. (Optional) Select the Watch collection checkbox to be notified when there are changes to the collection. This option isn't available when commenting on pull requests.

  4. Select Comment to add your comment.

Commenting on a collection

Add inline comments to a request or example

Use inline comments to comment on a specific part of a request or example. You can add comments to parameters, headers, and request bodies. You can also add comments to parts of a pre-request script or a test script. When there are new inline comments, a notification appears on the comments icon Inline comments icon in the request pane.

Before you switch to comment mode, make sure to save your changes first.

To add an inline comment to a request or example, do the following:

  1. Open the request or example.

  2. Select the comments icon Comments icon in the request pane to switch to comment mode.

    Switching to comment mode
  3. Select the part of the request or example you want to comment on and enter your comment. You can select text within a query parameter, path parameter, header, and request body (form-data, x-www-form-urlencoded, and raw). You can also select text within a pre-request script or test script.

  4. (Optional) Select the Watch collection checkbox to be notified when there are changes to the collection.

  5. Select Comment to add your comment. If comments are associated with a change, you can select the highlighted part of the request or example to view its comments.

    Adding an inline comment

Add inline comments to a pull request

Use inline comments to comment on a change in a pull request.

To add an inline comment to a pull request, do the following:

  1. Open the pull request.

  2. Select the comments icon Comments icon next to a change and enter your comment.

  3. Select Comment to add your comment. If comments are associated with a change, you can select the notification comments icon Comments notification icon next to a change to view its comments.

    Add an inline comment to a pull review

You can edit or delete a comment, or a get a link to a comment you can share with others.

  1. Select a collection, folder, request, example, or pull request in the sidebar, then select the comments icon Comments icon in the right sidebar.

  2. Select the more actions icon More actions icon next to a comment and do one of the following:

    • Select Copy link to copy a direct link to the comment to your clipboard.
    • Select Edit to make changes to the comment.
    • Select Delete to delete the comment.
Managing a comment

If you're a Workspace Admin, you can delete contributor comments, but you can't edit contributor comments.

Reply to comments

You can reply to a comment to keep the conversation going. Replies are grouped with the original comment, so you can have more than one comment thread on a collection, folder, request, example, or pull request. When you reply to a comment, the user who added the comment will receive a notification about your reply.

To reply to a comment, do the following:

  1. Select a collection, folder, request, example, or pull request in the sidebar, then select the comments icon Comments icon in the right sidebar.

  2. Select the comment you want to reply to and enter your reply.

    If you select an inline comment or open a link to an inline comment, Postman automatically switches to comment mode and opens the comment in context on the request.

  3. (Optional) Select the Watch collection checkbox to be notified when there are changes to the collection. This option isn't available when commenting on pull requests.

  4. Select Reply.

    Replying to a comment

If you're replying to a comment on a request or example, you can also select the highlighted part of the request or example.

Reply to an inline comment on a request or example

If you're replying to a comment on a change in a pull request, you can also select the notification comments icon Comments notification icon next to a change.

Reply to an inline comment on a pull review

Resolve comments

You can resolve a comment after it's been addressed.

  1. Select a collection, folder, request, example, or pull request in the sidebar, then select the comments icon Comments icon in the right sidebar.
  2. Select the resolve icon Resolve comment icon to resolve a comment and any associated replies.
Resolving a comment

You can't undo resolving a comment, but you can view resolved comments by selecting the filter icon Filter icon in the comments pane.

Mention teammates in comments

If you leave feedback or a question for a specific teammate, you can let them know by mentioning them in your comment. To mention a teammate in a comment, enter @ followed by their name, then select the person from the list.

When you mention a teammate in a comment, Postman sends them a notification about it. Select the notifications icon Notifications icon in the Postman header to view in-app notifications.

If your teammate doesn't have access to the collection they've been mentioned in, they'll need to request access before they can read the comment.

Last modified: 2023/11/15