Skip to navigation
API ReferenceIssues

Post a comment

Requires a user credential: a workspace API key has no author to attribute the change to and receives 403.

Requires the issues:write API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Path parameters

issueIdstringRequired

Issue UUID or label, e.g. VULN-000123.

Request

This endpoint expects an object.
bodystringRequired

Response

The posted comment.
idstringformat: "uuid"
issueIdstringformat: "uuid"
bodystring

Comment text as written; @handle mentions stay in place.

authorobject or null
Null when the author's account no longer exists.
createdAtdatetime
editedAtdatetime or null
urlstring
Console link to the comment.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error