Logo
15_Days_of_Postman_-_for_testers_IvanKo API Documentation

Create a request comment

POST {{baseUrl}}/collections/{{collectionUid}}/requests/{{requestUid}}/comments

Creates a comment on a request. Include the following in request body:

  • body — (Required) A string that contains the comment.

  • tags — An object that contains information about users tagged in the body comment. Include the following in this object:

    • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

      • type — (Required) A string that contains the user value.
      • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "data": { "id": 46814, "createdBy": 12345678, "createdAt": "2024-01-18T11:30:40.000Z", "updatedAt": "2024-01-18T11:30:40.000Z", "body": "This is an example. @alex-cruz" } }



Curl
curl -X POST 'https://api.getpostman.com/collections/collectionUid/requests/requestUid/comments' -d '{"body":"comment","tags":{"userName":{"type":"user","id":"userId"}}}'

ENDPOINTS