Create comment

Creates a comment using a personal access token or user-authorized OAuth token. clientRequestId makes retries durable without duplicate comments. The actor must still have access to the task and team on each request.

POST
/api/v1/workspaces/{workspaceId}/stories/{storyId}/comments

Creates a comment using a personal access token or user-authorized OAuth token. clientRequestId makes retries durable without duplicate comments. The actor must still have access to the task and team on each request.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid
storyId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/stories/497f6eca-6276-4993-bfeb-53cbbbba6f08/comments" \  -H "Content-Type: application/json" \  -d '{    "clientRequestId": "d7699708-5888-40fa-9713-ece0a3528b08",    "content": "string"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "storyId": "c0026cb9-d274-411b-905d-a8f8092fd598",    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",    "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",    "content": "string",    "replies": [      {}    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}