Description
This endpoint will delete a reply to a note on a Hi Marley case.
| Service Name | Delete Case Notes Reply |
| Service Type | REST |
| Method | DELETE |
| UAT (Sandbox) URL |
https://integration.uat.marley.ai/api/v2/case/{caseID}/notes/{noteId}/replies/{replyId} |
| Production URL | https://integration.himarley.io/api/v2/case/{caseID}/notes/{noteId}/replies/{replyId} |
| Technical Documentation | View technical documentation with sample request and response payloads hosted on Postman. |
Table of Contents
API Request
Flow
- Send API request with the path parameter of the Hi Marley Case ID, Note ID, and Reply ID.
- Hi Marley receives the request and validates the Case ID, Note ID, and Reply ID exist.
- Hi Marley responds with a 204 No Content response confirming that the note has been deleted.
Request Example
https://integration.uat.marley.ai/api/case/c808ba82-e2cb-4a92-9344-b924d79d2308/
notes/bf1559f6-7f57-4d07-bb18-5a7eb986310e/replies/556e14ac-25e7-489a-8458-1faf452d4d0b
Request Path Breakdown
| Property | Values | Description |
Type |
Required | Example | Validation |
| caseId | The Case ID associated with the Hi Marley case | string |
true |
c808ba82-e2cb-4a92-9344-b924d79d2308 |
caseId exists within Hi Marley |
|
| noteId | The Note ID within the Hi Marley case | string |
true |
bf1559f6-7f57-4d07-bb18-5a7eb986310e |
noteId exists within the Hi Marley case |
|
| replyId | The Reply ID attached to the Case Note in the Hi Marley case | string |
true |
0321654a-4ee0-45e3-9d46-8b7ca342ab94 |
replyId exists within the Hi Marley case |
API Response
- If this API request is passed successfully, you will receive a 204 No Content response with no response body
- If you try to use the Get Case Notes Reply API to retrieve this note, you will be able to retrieve this reply with the "archive" property set to "true"
Comments
0 comments
Please sign in to leave a comment.