Collections-Items-Responses-Comments

Number of APIs: 4

1. Get a response's comments

GET {{baseUrl}}/collections/{{collectionUid}}/responses/{{responseUid}}/comments

Gets all comments left by users in a response.

---

2. Create a response comment

POST {{baseUrl}}/collections/{{collectionUid}}/responses/{{responseUid}}/comments

Creates a comment on a response. 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.

---

3. Update a response's comment

PUT {{baseUrl}}/collections/{{collectionUid}}/responses/{{responseUid}}/comments/{{commentId}}

Updates a comment on a response. 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.

---

4. Delete a response's comment

DELETE {{baseUrl}}/collections/{{collectionUid}}/responses/{{responseUid}}/comments/{{commentId}}

Deletes a comment from a response. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

---