Create document comment

POST/workspaces/{organizationId}/documents/{id}/comments

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

bodystringrequired

min length 1

Responses

201Comment created

idstringrequired

organizationIdstringrequired

issueIdstring | nullrequired

documentIdstring | nullrequired

authorIdstring | nullrequired

bodystringrequired

resolvedAtstring | nullrequired

resolvedByIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

404Document not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

bodystring*

Request

curl -X POST "/workspaces/string/documents/string/comments" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

const response = await fetch("/workspaces/string/documents/string/comments", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/documents/string/comments",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"body\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "issueId": "string",
  "documentId": "string",
  "authorId": "string",
  "body": "string",
  "resolvedAt": "string",
  "resolvedById": "string",
  "createdAt": "string",
  "updatedAt": "string"
}