Add Comment to Request

POST

/api/v2/requests/{requestID}/comments

Last modified:2026-09-02 03:28:41

Adds a comment to a specific request.

To @-mention someone, put {u:userID} in the text where their name should appear — e.g.
"Please review {u:11299}". The mention renders as a live mention tag and notifies that
user, exactly as a mention created in the portal does.

Take the user IDs from GET /api/v2/requests/{requestID}/users, which lists exactly who can
be mentioned on this request. Mentioning anyone else is rejected with 400 — an engagement-wide
list such as GET /api/v2/engagements/{engagementID}/users may include users who are
restricted from this particular request.

A mentioned user is still subject to the normal notification rules: they must have request
comment emails enabled to actually receive one.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params

application/json

Required

Example

"string"

Responses

🟢201

Created: The comment was successfully added to the request.

This response does not have a body.

🟠400

🟠403

🟠404

Modified at 2026-09-02 03:28:41

Get Mentionable Users for a Request

Send Files to Engagement