Close Case API

Description

This API endpoint closes a Hi Marley case using the caseID as the unique identifier.

By integrating with this endpoint, a case in Hi Marley can be closed due to any associated actions taken in your system (e.g the Claim was closed in your claims system). This will ensure that adjusters only focus on the active queue of Hi Marley cases that have an open claim or policy associated with it.

Closing a case via API will close a case Hi Marley with the same workflows as if it was closed in the webapp including any custom automated messages configured for your organization, automated survey sends, or transcript uploads (triggered via webhook integration).

Service Name	Close Case
Service Type	REST
Method	PUT
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/actions/close
Production URL	https://integration.himarley.io/api/case/actions/close
Technical Documentation	API Endpoint - Postman Collection

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response 
  • Response Payload Example
  • Response: Case Response Structure
• Common Errors to Handle
  
  • [404] Case Not Found

API Request

Flow

1. Send API request with the path parameter of caseId.  
2. Hi Marley receives requests and validates the CaseID is for a valid case. passed has a state value of open.
3. API Response received with either success or error message based on validation. Success indicates that the case state value has been changed to closed on the caseId sent in the API request.

Request Example

https://integration.uat.marley.ai/api/case/actions/close/8f4acac7-9e77-4cc6-a2a9-e18dfae3873b

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The case identifier for the Hi Marley Case.	string	true	8f4acac7-9e77-4cc6-a2a9-e18dfae3873b	CaseID Exists

 

API Response 

Response: Case Response Structure

Common Errors to Handle

• [404] Case Not Found - More Details