POST /v1/comments

Family: Lists and collaboration · Operation ID: v1_create_comment

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open lists

Required scope: lists or bulk, based on the linked resource

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X POST "$API_BASE_URL/v1/comments" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Request body · application/json

{
  "$ref": "#/components/schemas/CreateCommentRequest",
  "definition": {
    "properties": {
      "author": {
        "nullable": true,
        "type": "string"
      },
      "body": {
        "type": "string"
      },
      "job_id": {
        "format": "int32",
        "nullable": true,
        "type": "integer"
      },
      "list_id": {
        "format": "int32",
        "nullable": true,
        "type": "integer"
      }
    },
    "required": [
      "body"
    ],
    "type": "object"
  }
}

Responses

201

{
  "description": "Comment created"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract