Applies to: Sprinklr Comment (Note) APIs V3
V2 API reference: Comment (Note) | Sprinklr Developer Portal
Comment (i.e. termed as Note in Sprinklr Platform) helps promote engagement between the agents working on the Case. By using Comment APIs, a brand agent sitting on a 3rd party tool can add comments on a case programmatically, which can be used by another agent for reference. Sprinklr supports APIs that allow adding, reading, updating, and deleting comments. The added advantage is to create notes with attachments such as image, file, or even video.
| Entity type | Identifier to send in entityId |
|---|---|
CASE | Case Number |
MESSAGE | Message Id |
OUTBOUND_MESSAGE | Outbound message (post) Id |
CAMPAIGN | Campaign Id |
PROFILE | Profile Id |
You need an access token and API key to call these APIs. Use the environment-specific API host shown in each endpoint.
POST Create Comment PUT Update Comment GET Read Comment / Fetch Comment DEL Delete Comment
All API calls are sent to the production endpoint:
https://api3.sprinklr.com/{env}/api/v3So the resource in production is:
https://api3.sprinklr.com/{env}/api/v3/commentReplace {env} with your assigned environment identifier (prod0, prod2, prod11, and so on — see APIs | Sprinklr Developer Portal for the environment list).
The API applies two global security schemes:
| Scheme | Type | Location |
|---|---|---|
bearerAuth | HTTP bearer (JWT) | Authorization: Bearer {{accessToken}} |
apiKeyAuth | API key | Key: {{apiKey}} |
| Header | Value | Description |
|---|---|---|
Authorization | Bearer {token} | Authenticates the user with the server. |
Key | {api-key} | Authenticates the application with the server. |
Content-Type | application/json | Identifies the request-body media type. |
Accept | application/json | Identifies the expected response type. |
Creates a comment on an entity, with an optional attachment. Request body is required, media type application/json.
Endpoint: api/v3/comment
| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
entityType | — | Required | String | Entity type: MESSAGE, OUTBOUND_MESSAGE, CASE, CAMPAIGN, PROFILE. |
entityId | — | Required | String | Entity id — e.g. Case Number for CASE, Message Id for MESSAGE. |
text | — | Required | String | The comment text. In V2's multiple-attachment endpoint this field was named comment. |
curl --location 'https://api3.sprinklr.com/{env}/api/v3/comment' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{
"entityType": "CASE",
"entityId": "116537343",
"text": "comment test"
}'{
"data": {
"id": "6a8825baa34ff204e0821a61",
"text": "comment test",
"commentingUser": 66015421,
"createdTime": 1787307448962,
"modifiedTime": 1787307448962,
"entityType": "CASE",
"entityId": "116537343",
"conversationId": "7608262980542680350",
"externalComment": {
"channelType": "TIKTOK"
}
},
"errors": []
}Using this API, you can add multiple attachments on a comment (note).
Endpoint: api/v3/comments
| Parameter | Sub-Parameter | Required | Type | Description |
|---|---|---|---|---|
entityType | — | Required | String | CASE, MESSAGE, etc. |
entityId | — | Required | String | ID of the entity |
text | — | Required | String | Comment text (previously comment field) |
attachments | — | Required | Array | Array of attachment objects |
attachments | url | Required | String | URL from Media Upload API response |
attachments | previewUrl | Optional | String | Preview URL from Media Upload API |
attachments | type | Required | Enum | IMAGE | VIDEO | DOC |
curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/comments' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"entityType": "CASE",
"entityId": "25253550",
"text": "Add Comment Attachments on Case",
"attachments": [
{
"url": "https://.../test_image_p.png",
"previewUrl": "...",
"type": "IMAGE"
},
{
"url": "https://.../GG.jpg",
"previewUrl": "...",
"type": "IMAGE"
}
]
}'{
"data": {
"id": "65d5acd6dff20160fd4ac551",
"object": "comment",
"text": "Add Comment Attachments on Case",
"attachments": {
"type": "MULTI_MEDIA",
"attachments": [
{
"url": "https://.../test_image_p.png",
"previewUrl": "...",
"type": "IMAGE"
},
{
"url": "https://.../GG.jpg",
"previewUrl": "...",
"type": "IMAGE"
}
]
},
"commentingUser": "user_1000157828",
"entityType": "CASE",
"entityId": "case_7252751",
"created_at": "2025-02-21T08:17:06Z",
"updated_at": "2025-02-21T08:17:06Z",
"url": "/api/v3/comments/65d5acd6dff20160fd4ac551"
}
}| Parameter | Description | Type |
|---|---|---|
id | Unique identifier of the comment | String |
object | Always "comment" | String |
text | The comment text | String |
attachments | Multi-media attachment object with nested array and type: MULTI_MEDIA | Object |
commentingUser | User ID of the commenter | String |
entityType | Entity type on which the comment was created | String |
entityId | ID of the entity on which the comment was created | String |
created_at | ISO 8601 timestamp of comment creation (v2 was Epoch ms) | String |
updated_at | ISO 8601 timestamp of last modification (v2 was Epoch ms) | String |
url | Self-referencing URL of the created comment | String |
Updates a comment's text, media, external reply metadata, and/or channel sync fields.
Endpoint: api/v3/comment/{commentId}?entityType={entity type}&entityId={entity id}
| Parameter | In | Required (spec) | Required (docs) | Type | Description |
|---|---|---|---|---|---|
commentId | path | Yes | Required | String | Id of the comment to update. |
entityType | query | No | Required | String | Entity type (enum name, e.g. CASE). |
entityId | query | No | Required | String | Id of the entity. |
| Property | Type | Description |
|---|---|---|
entityType | EntityType | Optional; if set, must match the entityType query parameter. |
entityId | string | Id of the entity. |
text | string | Text of the comment. |
attachment | Attachment | Attachment of the comment. |
externalComment | ExternalComment | Third-party channel comment details when comments are synced with another system. |
inReplyToCommentId | string | Parent comment's id to which this is a reply. |
channelAssetId | string | Channel-native asset id. |
channelCommentId | string | Channel-native comment id. |
channelType | string | Channel type. |
channelCreationTime | int64 | Channel creation time (epoch ms). |
channelModificationTime | int64 | Channel modification time (epoch ms). |
curl --location --request PUT \
'https://api3.sprinklr.com/{env}/api/v3/comment/{commentId}?entityType=CASE&entityId=116537343' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{
"text": "new comment updated",
"entityType": "CASE",
"entityId": "116537343"
}'HTTP/1.1 204 (No Content) Deletes one or more comments.
Endpoint: api/v3/comment?entityType={entitytype}&entityId={entityid}&id={commentId}
| Parameter | In | Required (spec) | Required (docs) | Type | Description |
|---|---|---|---|---|---|
entityType | query | No | Required | String | Entity type (enum name, e.g. CASE). |
entityId | query | No | Required | String | Id of the entity. |
id | query | No | Required | String | Comment id(s): one id or a comma-separated list, maximum 50, all sharing the same entityType and entityId. |
curl --location --request DELETE \
'https://api3.sprinklr.com/{env}/api/v3/comment?entityType=CASE&entityId=116537343&id={commentId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json'HTTP/1.1 204 (No Content) You can use the Fetch Comment API to fetch the comment from different entity types using entity Id and comment Id.
Endpoint: api/v3/comment?entityType={entitytype}&entityId={entityid}&id={comment id}
| Parameter | In | Required (spec) | Required (docs) | Type | Description |
|---|---|---|---|---|---|
entityType | query | No | Required | String | Entity type for which the comment is being fetched. Supported values: MESSAGE, CASE, CAMPAIGN, PROFILE. |
entityId | query | No | Required | String | Unique identifier of the entity — Case Number for CASE, Message Id for MESSAGE, Campaign Id for CAMPAIGN, Profile Id for PROFILE. |
id | query | No | Required | String | Comment id(s): one id or a comma-separated list, maximum 50, all sharing the same entityType and entityId. |
curl --location \
'https://api3.sprinklr.com/{env}/api/v3/comment?entityType=CASE&entityId=116537343&id={commentId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json'{
"data": [
{
"id": "6a883e6cd4bb4391d375feea",
"text": "comment test",
"commentingUser": 66015421,
"createdTime": 1787313772664,
"modifiedTime": 1787313772664,
"entityType": "CASE",
"entityId": "116537343",
"conversationId": "7608262980542680350",
"externalComment": {
"channelType": "TIKTOK"
}
}
],
"errors": []
}| Parameter | Type | Description |
|---|---|---|
id | String | Unique id of the comment. |
text | String | Text of the comment. |
attachment | Object (Attachment) | Attachment of the comment. |
commentingUser | Long (int64) | Sprinklr user id of the user who made the comment. |
createdTime | Epoch (int64, ms) | Time when the comment was made. |
modifiedTime | Epoch (int64, ms) | Time when the comment was last updated. |
entityType | String | Entity type on which the comment was created. |
entityId | String | Id of the entity on which the comment was created. |
conversationId | String | Conversation id of the entity on which the comment was created, if applicable. |
externalComment | Object (ExternalComment) | Details of the channel comment, if applicable. |
isPrivate | Boolean | Private comment — internal only, not synced to third-party integrations. |
inReplyToCommentId | String | Parent comment's id to which this is a reply. |
errors | Array | Error details, if any. |
ExternalComment object
| Property | Type | Description |
|---|---|---|
channelType | String | Channel type, e.g. salesforce, zendesk, rightnow. The documented example returns TIKTOK. |
commentId | String | Unique id of the third-party comment. |
assetId | String | Unique id of the third-party asset on which the comment was made. |
ownerId | String | Owner of the comment on the third-party channel. |
creationTime | int64 | Channel creation time (epoch ms). |
modificationTime | int64 | Channel modification time (epoch ms). |
Create notes containing supporting media or documents. The API supports attachments with types IMAGE, VIDEO, and DOC.
Use the multiple-attachment operation to associate multiple attachment objects with a single comment, including their URLs, optional preview URLs, and attachment types.
Fetch comments associated with a particular entity by using its entityType, entityId, and comment ID. The API can also accept a comma-separated list of comment IDs, up to 50 IDs that share the same entity type and entity ID.
Modify an existing comment, including its text, attachment, external-comment information, reply relationship, and documented channel synchronisation fields.
Comment (Note) API V3 — Developer Guide