Add internal note
Create an internal note in a conversation by providing the conversation id.
The created internal note
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Agent was not found, Invalid date format
An entity in this request could not be found
Internal failure during request processing
- Payload
- curl
- JavaScript
- Python
- PHP
- Java
- Go
- Ruby
{- "message": "A sample note",
- "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
}- 200
- 400
- 404
- 500
{- "data": {
- "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
- "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
- "csid": 9456,
- "message": "A sample note"
}
}Add internal notes
Create internal notes in a conversation by providing the conversation id.
The created internal notes
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body
An entity in this request could not be found
Internal failure during request processing
- Payload
- curl
- JavaScript
- Python
- PHP
- Java
- Go
- Ruby
{- "data": [
- {
- "message": "A sample note",
- "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
}, - {
- "message": "Another sample note"
}
]
}- 200
- 400
- 404
- 500
{- "data": [
- {
- "data": {
- "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
- "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
- "csid": 9456,
- "message": "A sample note"
}, - "_type": "BulkActionSuccess"
}, - {
- "error": {
- "message": "An agent with id:... cannot be found in org."
}, - "_type": "BulkActionFailure"
}
]
}List internal notes
Get all internal notes for a particular conversation by providing the conversation id.
List of internal notes for a conversation sorted from oldest to newest
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
- curl
- JavaScript
- Python
- PHP
- Java
- Go
- Ruby
- 200
- 400
- 404
- 500
{- "data": [
- {
- "id": "3346b99c-8128-4276-ac40-5f30c959e5e7",
- "authorId": "c68f42a5-1453-497a-940f-ff36ed4f1631",
- "createdAt": "2021-01-20T09:00:00Z",
- "csid": 7392,
- "message": "A note to remember"
}, - {
- "id": "22b8e6b6-4576-4dc0-ab05-60f81e8b0708",
- "authorId": "124d54bb-92d6-41c9-a675-788d6a8c821e",
- "createdAt": "2021-01-22T12:00:00Z",
- "csid": 7392,
- "message": "A note to forget"
}
]
}