LogoLogo
  • About
  • Quick Start
  • API reference
    • Workspace
      • Dependencies
      • Copy
      • Property definitions
        • Reorder
      • Property instances
        • Reorder
        • Lock
        • Unlock
      • Blocks
      • Comments
        • Parent
      • Data Sinks
    • Webhooks
      • Rotate secret
    • Cloud storage
      • Redirect
      • Thumbnail
      • Upload complete
      • Retry conversion
      • Download
      • Upload link
      • Version list
      • Metadata
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. Workspace

Comments

PreviousBlocksNextParent

Was this helpful?

delete
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/comments/{id}'
200
403
No body

Removes a comment.

  • POST/v1/workspace/{workspaceId}/comments
  • GET/v1/workspace/{workspaceId}/comments/{id}
  • DELETE/v1/workspace/{workspaceId}/comments/{id}
  • PATCH/v1/workspace/{workspaceId}/comments/{id}
get
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/workspace/{workspaceId}/comments/{id}'
200
403
No body

Retrieves a comment by ID.

post
Path parameters
workspaceIdstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
objectoptional
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/comments' \
  --header 'Content-Type: application/json' \
  --data '{}'
201
403
No body

Creates a new comment.

patch
Path parameters
workspaceIdstringrequired
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
objectoptional
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/comments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{}'
200
403
No body

Updates a comment.