Description
The Get Participants API allows carriers with Multi-Party Texting to retrieve all active participants of a Hi Marley Case.
| Service Name | Get Participants |
| Service Type | REST |
| Method | DELETE |
| UAT (Sandbox) URL | https://integration.uat.marley.ai/api/case/:caseId/participants/:id |
| Production URL | https://integration.himarley.io/api/case/:caseId/participants/:id |
| Technical Documentation | View technical documentation with sample request and response payloads hosted on Postman. |
API Request
Request Example
https://integration.uat.marley.ai/api/case/11b2df09-9b5f-471c-8b32-c16b30e08a08/participants/389fb0b1-1f92-4325-a5c6-6ebeac2f495d
Request Path Breakdown
| Property | Description | Type | Required | Example |
| caseId | The Case ID associated with the Hi Marley Case. | string | true | 364ef9bb-fae5-4e2a-a746-cdca465a9c16 |
| id | The id of the target participant | string | true | "id": "d6a3426f-5d2e-411b-858f-fe39b562bb53" |
Response:
This DELETE endpoint does not return a response body. A successful deletion is indicated by an HTTP status code:
204 No Content— The participant has been successfully deleted.
Comments
0 comments
Please sign in to leave a comment.