Create comment on KObject

Comments let agents discuss a KObject, for example to record progress on a task or ask a teammate about a return. They appear on the record in the agent desktop for Klasses that have the commentable mixin. Comments are separate from notes: notes attach to customers and conversations, while comments attach only to KObjects.

A comment is created against one KObject and stays attached to it. Its body can be edited later, and it is removed with DELETE. Only the comment's author can edit or delete it, unless the caller has admin access to notes. Responses also include relationships to the related customer, conversation and Klass, and to the assigned user and team where there are any.

Key fields

Field	Meaning
`body`	Required. The comment text, up to 10,240 characters.
`userMentions`	Up to 20 mentions, each with a `user` or a `team` ID.
`attachments`	Files attached to the comment. Read them back with `include=attachments`, or manage them with the comment attachments endpoints.
`importedAt`	Marks a comment you are importing from another system.
`object`	In responses, the KObject the comment belongs to.

createdAt, modifiedAt, deletedAt and the createdBy, modifiedBy and deletedBy relationships record who did what and when.

Which endpoint to use

To	Call
List the comments on a KObject	`GET /v1/kobjects/{id}/comments`
Add a comment to a KObject	`POST /v1/kobjects/{id}/comments`
Read one or several comments	`GET /v1/comments/{id}`
Edit or delete a comment	`PUT` or `DELETE /v1/comments/{id}`

The list endpoint takes the KObject's ID (no Klass name needed), pages with page and pageSize, and sorts by createdAt with sort=asc or sort=desc. GET /v1/comments/{id} accepts a comma-separated list of IDs to fetch several comments at once. Permissions differ by endpoint: listing comments needs KObject read access, while reading, creating, updating and deleting individual comments use note roles (such as org.permission.note.create), so give your API key both.

curl --request POST \ --url 'https://api.kustomerapp.com/v1/kobjects/57ce17d2369f251400fc8e89/comments' \ --header "Authorization: Bearer $KUSTOMER_API_KEY" \ --header 'Content-Type: application/json' \ --data '{ "body": "Followed up with the customer about this order." }'

{ "data": { "type": "comment", "id": "5828a3be7c7f551a00b5b720", "attributes": { "body": "Followed up with the customer about this order.", "createdAt": "2021-11-13T17:32:46.480Z", "updatedAt": "2021-11-13T17:32:46.480Z", "rev": 1 }, "relationships": { "object": { "links": { "self": "/v1/kobjects/57ce17d2369f251400fc8e89" }, "data": { "type": "kobject", "id": "57ce17d2369f251400fc8e89" } }, "org": { "links": { "self": "/v1/orgs/57bb5d2e32e83a130052e94e" }, "data": { "type": "org", "id": "57bb5d2e32e83a130052e94e" } }, "createdBy": { "links": { "self": "/v1/users/57bb5d2e32e83a130052e94f" }, "data": { "type": "user", "id": "57bb5d2e32e83a130052e94f" } } }, "links": { "self": "/v1/comments/5828a3be7c7f551a00b5b720" } } }

Comments

Key fields

Which endpoint to use

Path parameters

Request body

Responses