Activities
Add a comment to an activity
Adds a private comment to a message or a call on a ticket. Mention teammates by user id to notify them, attach files you uploaded first, and send a client id so a retry does not add it twice. Dividers such as "Opened by", system notes and a call's wrap-up note do not take comments: the answer is 422 with the code parent_not_commentable. Comment on the message or the call instead.
Requires: desk.write scope, Converse licence.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Path Parameters
id*string
The activity's id (a UUID).
Request Body
application/json
Response
OK
Example
{ "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "ticket_id": "b1e8bf6f-7f06-4c91-96dd-a1eb7abe504b", "parent_activity_id": "861eb1a7-8ac3-422a-9e01-4812b7382c79", "author_user_id": "cacbaaf9-2b98-46a1-9b0e-04f92c823408", "author_name": "Wanjiku Mwangi", "body": "Hi Amina, your order has shipped.", "mentions": [ "af55b8ed-074f-478d-9661-0c5ccc54d6d5" ], "created_at": "2026-10-14T08:30:00Z", "edited_at": "2026-10-14T08:30:00Z", "attachments": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "filename": "invoice-1182.pdf", "content_type": "application/pdf", "size": 1, "url": "https://example.com/file" } ]}FieldTypeDescription
idrequiredstring (uuid)ticket_idrequiredstring (uuid)The id of the ticket this is about.parent_activity_idrequiredstring (uuid)author_user_idrequiredstring (uuid) | nullauthor_namerequiredstringbodyrequiredstringThe message text.mentionsrequiredstring (uuid)[]The ids of the teammates to notify about the comment.created_atrequiredstring (date-time)edited_atrequiredstring (date-time) | nullattachmentsrequiredobject[]idrequiredstring (uuid)filenamerequiredstringcontent_typerequiredstringsizerequiredintegerurlrequiredstringcurl -X POST "https://api.sautidesk.com/v1/desk/activities/string/comments" \ -H "Content-Type: application/json" \ -d '{ "body": "Can you check the Kisumu order?", "mentions": [] }'