Create document comment

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

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

bodystringrequired

min length 1

Responses

201

Comment created

idstringrequired

organizationIdstringrequired

issueIdstring | nullrequired

documentIdstring | nullrequired

authorIdstring | nullrequired

bodystringrequired

resolvedAtstring | nullrequired

resolvedByIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

404

Document not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Bodyapplication/json

bodystring*

Request

curl -X POST 'https://pile.nyc/workspaces/string/documents/string/comments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/documents/string/comments", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/documents/string/comments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "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"
}