Skip to main content

Manage Comments

Open, answer, resolve and delete the comment threads on a project's canvas. These endpoints are the REST twins of the MCP tools create_comment, reply_to_comment, resolve_comment and delete_comment, and behave the same way. List Comments reads the threads.

Everything is posted under the name of the user the API token belongs to.

Authentication​

All requests require a valid API token. You can generate an API token at https://account.deon.cloud/account/api-tokens. Include it as a Bearer token in the Authorization header:

Authorization: Bearer <your-api-token>

Viewers can open threads, reply, and delete their own posts and the threads they opened. Resolving, reopening and deleting someone else's thread need edit access.

Endpoints​

MethodPathBodyDoes
POST/api/v2/projects/{projectId}/comments{ "text", "itemId"?, "x"?, "y"? }Opens a thread.
POST/api/v2/projects/{projectId}/comments/{threadId}/replies{ "text" }Replies in a thread.
PATCH/api/v2/projects/{projectId}/comments/{threadId}{ "resolved" }Resolves (true, also when resolved is left out) or reopens (false) a thread.
DELETE/api/v2/projects/{projectId}/comments/{threadId}—Deletes a thread and its pin.
DELETE/api/v2/projects/{projectId}/comments/{threadId}/posts/{postId}—Deletes one of your own posts.

{threadId} takes a thread's threadId or its pin's itemId, both of which List Comments returns.

Open a thread​

Pass itemId to pin the comment at the item's top-right corner, or x and y for the pin's top-left in canvas coordinates.

{ "text": "Is this price final?", "itemId": "11aa22bb-..." }
{
"threadId": "5e6f7a8b-...",
"itemId": "9c0d1e2f-...",
"postId": "aa11bb22-...",
"position": { "x": 352, "y": 208 }
}

Reply​

A reply to a resolved thread reopens it when the caller may edit the board; reopened says whether it did.

{ "threadId": "5e6f7a8b-...", "postId": "cc33dd44-...", "reopened": false }

Resolve or reopen​

{ "threadId": "5e6f7a8b-...", "resolved": true, "changed": true }

changed is false when the thread already was in that state.

Delete​

{ "threadId": "5e6f7a8b-...", "deleted": "thread" }

A whole thread can be deleted by the person who opened it or by anyone who can edit the board; a post only by its author. Deleting the last post of a thread deletes the thread and its pin, and the response says "deleted": "thread". A comment pin cannot be deleted through the item endpoints; delete its thread here.

Errors​

StatusWhen
400The text is empty, or neither itemId nor x and y is given.
403The caller may not do this: resolving without edit access, deleting someone else's post, or deleting someone else's thread without edit access.
404The project, thread, post or item does not exist.

Examples​

curl​

curl -X POST "https://api.deon.cloud/api/v2/projects/{projectId}/comments/{threadId}/replies" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "text": "Fixed: the title is 48 pt now." }'
curl -X PATCH "https://api.deon.cloud/api/v2/projects/{projectId}/comments/{threadId}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "resolved": true }'