Comments
post
Path parameters
workspaceIdstringRequired
Header parameters
x-api-keystringOptional
An x-api-key required for authentication
Body
objectOptional
Responses
201
Creates a new comment.
403
Forbidden. User does not have permission to create a comment or the parent resource does not exist.
post
POST /v1/workspace/{workspaceId}/comments HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2
{}No content
get
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional
An x-api-key required for authentication
Responses
200
Retrieves a comment by ID.
403
Forbidden. User does not have permission to access the comment or the comment does not exist.
get
GET /v1/workspace/{workspaceId}/comments/{id} HTTP/1.1
Host:
Accept: */*
No content
delete
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional
An x-api-key required for authentication
Responses
200
Removes a comment.
403
Forbidden. User does not have permission to remove the comment or the comment does not exist.
delete
DELETE /v1/workspace/{workspaceId}/comments/{id} HTTP/1.1
Host:
Accept: */*
No content
patch
Path parameters
workspaceIdstringRequired
idstringRequired
Header parameters
x-api-keystringOptional
An x-api-key required for authentication
Body
objectOptional
Responses
200
Updates a comment.
403
Forbidden. User does not have permission to update the comment or the comment does not exist.
patch
PATCH /v1/workspace/{workspaceId}/comments/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2
{}No content
Was this helpful?