Document Comments

Post Thread Comment

Posts a new comment to an existing thread on a document. The comment text must be non-empty and cannot exceed 10,000 characters.

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
post/v1/documents/{documentId}/threads/{threadId}/comments

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{documentId}/threads/{threadId}/comments
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content, lucidscale.document.content, lucidspark.document.content, lucid.document.content)

Path parameters

documentIdstring uuid required

ID of the document containing the thread.

threadIdstring required

ID of the comment thread to post a comment to.

Request body

commentstring required

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

Example request

{
  "comment": "This is a comment"
}

Response

No Content when the comment is successfully posted.

Changes

No recorded changes to this operation across all 1 revision of this API.