Patch

/v3/projects/{project_id}/categories/{category_id}/comments/{comment_id}

Updates an existing thread. Send status to resolve or reopen it, comment to replace its body, or both. Semantics match the article endpoint: resolving is idempotent, an unreachable transition is refused with 422 (a thread is reopened only after having been resolved, and open cannot be set), and the two fields carry different access rules — status needs permission to resolve comments, while editing comment is restricted to the thread's author.

Before you call this

GET /v3/projects/{project_id}/categories/{category_id}/comments — Lists the threads on the page category. Supplies the comment_id to update and its current status.

See also

POST /v3/projects/{project_id}/categories/{category_id}/comments/{comment_id}/replies — Adds a reply instead of editing someone else's body.

Security

API Key: ApiKey

Header parameter nameX-API-Key

API key for machine-to-machine integrations, webhooks, and CI/CD (recommended). This is a static, pre-shared secret - treat it as an opaque string and do not parse it; it is an API key, not an OAuth 2.0 access token. Create one in the portal under Settings > Knowledge base portal > API keys using the Create API key button - this is a different credential from the V1/V2 API token, which lives on its own screen and will not authenticate a V3 request. The plaintext key (format d360_sk_...) is shown only once, at creation. Send it in the X-API-Key header: X-API-Key: d360_sk_.... Each key carries a fixed portal role, content role, and content-access scope, supports an optional expiry, and can be disabled or deleted at any time from the portal.

OAuth

All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.

FlowAuthorization Code

Authorization URLhttps://identity.document360.io/connect/authorize

Token URLhttps://identity.document360.io/connect/token

Scopes:

customerApiDocument360 Customer API

Path parameters

project_id

string (uuid) Required

The unique identifier of the project. Retrieve project IDs from GET /v3/projects.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

category_id

string (uuid) Required

The unique identifier of the category. Retrieve category IDs from GET /v3/projects/{projectId}/categories.

Exampleb4c5d6e7-f8a9-0b1c-2d3e-4f5a6b7c8d9e

comment_id

string (uuid) Required

The identifier of the comment thread to update.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

Query parameters

lang_code

string (language-tag)

ISO 639-1 language code (e.g., en, fr). Defaults to the project's primary language if omitted.

Pattern^[a-z]{2}(-[A-Z]{2})?$

Exampleen

Body parameters

The status and/or body to apply.

Resolve the thread

Marks the discussion settled. Safe to repeat: a thread that is already resolved is left alone and still returns 200, so a retry after a timeout cannot reopen it.

{
  "status": "resolved",
  "comment": null,
  "mentioned_user_ids": null
}

Reopen a resolved thread

Returns a resolved thread to discussion. Only reachable from resolved — reopening a thread that was never resolved is rejected with 422, and open cannot be set at all.

{
  "status": "reopened",
  "comment": null,
  "mentioned_user_ids": null
}

Edit the comment body (author only)

Replaces the body and its @-mentions. Restricted to the thread's original author whatever their permissions; anyone else gets 403 and should reply instead.

{
  "status": null,
  "comment": "Confirmed with security — ninety days is correct.",
  "mentioned_user_ids": [
    "7c1e4d90-2a3b-4c5d-8e9f-0a1b2c3d4e5f"
  ]
}

Edit and resolve in one call

Both fields applied together. Because their access rules differ, a caller who is permitted to resolve but is not the author will be refused — send the two changes separately if that applies.

{
  "status": "resolved",
  "comment": "Confirmed with security — ninety days is correct.",
  "mentioned_user_ids": null
}

object

Updates an existing comment thread: its resolution status, its body, or both.

status

string | null

New resolution status: resolved or reopened. Omit to leave the status untouched. open is not accepted — a thread returns to discussion as reopened, which records that it had been resolved once.

Valid values[ "open", "resolved", "reopened" ]

Exampleresolved

comment

string | null

Replacement comment body. Author-only. Omit to leave the body untouched.

Min length1

Max length3000

Example<p>Confirmed with security — ninety days is correct.</p>

mentioned_user_ids

Array of string | null

Replaces the @-mentions on the comment. Only applied when comment is also supplied, because the two are stored by the same operation.

string

Responses

200

Comment updated, or already in the requested state.

Headers

X-RateLimit-Limit

integer

The maximum number of requests allowed in the current time window for this request's bucket. Read requests (GET/HEAD) and write requests (POST/PUT/PATCH/DELETE) have independent limits, applied per caller (API key or user) per project.

X-RateLimit-Remaining

integer

The number of requests remaining in the current time window. When this reaches 0, subsequent requests receive a 429 response.

Comment resolved

status is now resolved and resolved_by_user_id names the user who resolved it — both read back from storage rather than echoed from the request.

{
  "data": {
    "id": "b7f3c1a0-5e42-4d18-9a6c-2f8091d3e547",
    "title": "single sign-on",
    "comment": "Should we link the SSO setup guide here?",
    "commented_text": "single sign-on",
    "commented_text_truncated": false,
    "status": "resolved",
    "author_user_id": "7c1e4d90-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
    "resolved_by_user_id": "9d2f5e01-3b4c-5d6e-9f0a-1b2c3d4e5f60",
    "mentioned_user_ids": [],
    "replies": [
      {
        "id": "4b81c07e-9d35-4a62-8f10-6c27b5e0a913",
        "comment": "Agreed, linking it now.",
        "author_user_id": "9d2f5e01-3b4c-5d6e-9f0a-1b2c3d4e5f60",
        "mentioned_user_ids": [],
        "created_at": "2026-07-29T10:02:44.120Z",
        "modified_at": "2026-07-29T10:02:44.120Z"
      }
    ],
    "replies_count": 1,
    "created_at": "2026-07-29T09:41:12.480Z",
    "modified_at": "2026-07-29T11:15:03.220Z"
  },
  "success": true,
  "request_id": "0HNNG2FP7GHU5:00000003",
  "errors": null,
  "warnings": null
}

Expand All

object

Generic API response wrapper containing typed data.

data

object

Response data payload.

id

string (uuid) | null

Unique identifier of the comment thread, and the value carried by the comment's marker in the content as data-comment-id.

Do not rely on finding it in a content_mode=raw response. Raw mode returns the DFM markdown representation, and a <mark> marker does not survive the conversion into it — only the Editor 3.0 <span> form passes through. Use Document360.Customer.API.Models.V3.CommentResponse.CommentedText to learn what a comment annotates rather than searching the content yourself.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

title

string | null

Optional title/summary of the comment thread.

comment

string | null

The comment body (sanitized HTML).

commented_text

string | null

The text in the document that this comment annotates — the content inside its highlight marker — as plain text.

Read from the document's current content on every request rather than stored with the comment, so it always reflects what the text says now. A consequence worth knowing: edit the annotated sentence and this value changes; it is not a record of what the text said when the comment was written.

null when the annotated text cannot be determined, which is an ordinary outcome and not an error — the marker was removed (the thread is orphaned and now annotates nothing), the document is stored in a form this cannot read, or the comment predates the marker convention. Treat it as "unknown", and do not assume a comment with null here is invalid.

A comment may annotate a selection spanning several paragraphs; those fragments are joined with single spaces, and runs of whitespace from the document's own markup are collapsed. Long selections are truncated — see Document360.Customer.API.Models.V3.CommentResponse.CommentedTextTruncated.

Examplesingle sign-on

commented_text_truncated

boolean

Whether Document360.Customer.API.Models.V3.CommentResponse.CommentedText was cut short because the annotated selection exceeded the response limit. When true, the value is a prefix of the real annotated text, not the whole of it — fetch the document content if the full span matters.

status

string

Resolution status of the thread.

Valid values[ "open", "resolved", "reopened" ]

author_user_id

string | null

Identifier of the team account that created the comment.

resolved_by_user_id

string | null

Identifier of the team account that resolved the thread. null when still open.

mentioned_user_ids

Array of string | null

Identifiers of team accounts @-mentioned in the comment.

string

replies

Array of object (CommentReplyResponse) | null

Replies on this comment thread.

object

A reply within an inline comment thread.

id

string (uuid) | null

Unique identifier of the reply.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

comment

string | null

The reply body (sanitized HTML).

author_user_id

string | null

Identifier of the team account that created the reply.

mentioned_user_ids

Array of string | null

Identifiers of team accounts @-mentioned in the reply.

string

created_at

string (date-time)

UTC timestamp when the reply was created.

modified_at

string (date-time)

UTC timestamp when the reply was last modified.

replies_count

integer (int32)

Total number of replies on the thread.

created_at

string (date-time)

UTC timestamp when the comment was created.

modified_at

string (date-time)

UTC timestamp when the comment was last modified.

success

boolean

Whether the API request was successful.

request_id

string

Unique identifier for request tracing and correlation.

Min length1

errors

Array of object (ApiError) | null

List of errors if the request failed.

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

List of non-fatal warnings from the request.

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

400

The request body is malformed or contains invalid JSON.

Malformed request body

The request body could not be parsed.

{
  "type": "https://apidocs.document360.io/apidocs/errors/bad-request",
  "title": "Bad Request.",
  "status": 400,
  "detail": "The request body is malformed or contains invalid JSON.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "BAD_REQUEST",
      "message": "Could not parse the request body. Ensure it is valid JSON.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

401

Authentication token is missing or invalid.

Headers

WWW-Authenticate

string

Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.

Missing or invalid token

Authentication token is missing or invalid.

{
  "type": "https://apidocs.document360.io/apidocs/errors/unauthorized",
  "title": "Unauthorized.",
  "status": 401,
  "detail": "The authentication token is missing or has expired.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Bearer token is missing or invalid.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

403

The role does not grant categories.update, node-level access is denied, the role cannot resolve comments, or the body edit was attempted by someone other than the author.

Insufficient permissions

Insufficient permissions for this resource.

{
  "type": "https://apidocs.document360.io/apidocs/errors/forbidden",
  "title": "Forbidden.",
  "status": 403,
  "detail": "You do not have permission to perform this action.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "FORBIDDEN",
      "message": "Insufficient permissions for this project.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

404

Category, language, or comment thread not found.

Resource not found

The requested resource was not found.

{
  "type": "https://apidocs.document360.io/apidocs/errors/resource-not-found",
  "title": "Not Found.",
  "status": 404,
  "detail": "The requested resource does not exist or has been deleted.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "RESOURCE_NOT_FOUND",
      "message": "The requested resource was not found.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

409

The comment's status changed while this request was being processed (another update, or a resolve-all). Re-read the comment and retry if the change still applies.

Resource conflict

The request conflicts with the current state of the resource.

{
  "type": "https://apidocs.document360.io/apidocs/errors/conflict",
  "title": "Conflict.",
  "status": 409,
  "detail": "The resource is in a state that conflicts with this operation.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "CONFLICT",
      "message": "A draft version already exists for this resource.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

422

The payload is invalid, status is open, or the requested status cannot be reached from the thread's current state, or one or more mentioned_user_ids are not members of this project.

Validation failed

The request body contains invalid data.

{
  "type": "https://apidocs.document360.io/apidocs/errors/validation-error",
  "title": "Unprocessable Entity.",
  "status": 422,
  "detail": "One or more fields failed validation.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "This field is required.",
      "field": "title",
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

429

Rate limit exceeded. Retry after the duration specified in the Retry-After header.

Headers

Retry-After

integer

Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.

X-RateLimit-Limit

integer

The maximum number of requests allowed in the current time window for this request's bucket. Read requests (GET/HEAD) and write requests (POST/PUT/PATCH/DELETE) have independent limits, applied per caller (API key or user) per project. Read limits are typically higher than write limits.

X-RateLimit-Remaining

integer

The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.

X-RateLimit-Reset

integer

The UTC epoch timestamp (in seconds) when the current rate limit window resets.

Rate limit exceeded

Rate limit exceeded.

{
  "type": "https://apidocs.document360.io/apidocs/errors/too-many-requests",
  "title": "Too Many Requests.",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

500

An unexpected server error occurred.

Unexpected server error

Unexpected server error.

{
  "type": "https://apidocs.document360.io/apidocs/errors/internal-server-error",
  "title": "Internal Server Error.",
  "status": 500,
  "detail": "An unexpected error occurred. Please try again or contact support.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

type

string

URI reference identifying the error type (links to documentation).

Valid values[ "https://apidocs.document360.io/apidocs/errors/bad-request", "https://apidocs.document360.io/apidocs/errors/unauthorized", "https://apidocs.document360.io/apidocs/errors/forbidden", "https://apidocs.document360.io/apidocs/errors/resource-not-found", "https://apidocs.document360.io/apidocs/errors/conflict", "https://apidocs.document360.io/apidocs/errors/validation-error", "https://apidocs.document360.io/apidocs/errors/too-many-requests", "https://apidocs.document360.io/apidocs/errors/internal-server-error" ]

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

Valid values[ 400, 401, 403, 404, 409, 422, 429, 500 ]

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Valid values[ "ARCHIVED_CONTENT_READ_ONLY", "ARCHIVE_ALREADY_ARCHIVED", "ARCHIVE_NOT_ARCHIVED", "BAD_REQUEST", "CONFLICT", "FEATURE_NOT_IN_LICENSE", "FORBIDDEN", "INTERNAL_SERVER_ERROR", "LICENSE_LIMIT_EXCEEDED", "OPERATION_FAILED", "PREMIUM_FEATURE_NOT_IN_LICENSE", "RESOURCE_NOT_FOUND", "TOO_MANY_REQUESTS", "UNAUTHORIZED", "UNRECOGNIZED_FIELD", "UNRECOGNIZED_FIELDS", "VALIDATION_ERROR" ]

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

Resolve, reopen, or edit a comment on a page category