Post Document Thread

Creates a document-level comment thread with an initial comment. The thread is not attached to a
document item or canvas location. The comment text must be non-empty and cannot exceed 10,000 characters.

Open the document in the editor at least once before creating a thread. Thread creation is not supported
while the document is awaiting its initial editor setup.

Valid Authentication Methods

API Key Grants:

  • DocumentEdit

OAuth 2.0 User Token Scopes:

  • lucidchart.document.content
  • lucidscale.document.content
  • lucidspark.document.content
  • lucid.document.content
Path Params
uuid
required

ID of the document on which to create the thread.

Body Params

Request body for posting a comment to a thread.

string
required

The text content of the comment. Must be non-empty and at most 10,000 characters.

Responses

400

Bad Request.

  • Document must have completed its initial editor setup. Open the document in the editor and retry.
  • Comment must be non-empty.
  • Comment must not exceed 10,000 characters.
403

Forbidden if the app making the request does not have write permission to the document, or if the document does not exist.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json