Description

This endpoint will update the Case data associated to a Hi Marley Case ID. Most fields can be updated except for the customer fields.

Service Name	Update Case By Case ID
Service Type	REST
Method	PUT
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/{caseId}
Production URL	https://integration.himarley.io/api/case/{caseId}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

API Request
API Response
- Response: Case Response Structure

API Request

Flow

Send API request with the path parameter of the Hi Marley Case ID.
Hi Marley receives the request, validates the Case ID exists, and validates each field to be updated.
Hi Marley responds with the Case Data associated including updates that we successfully made.

Request Example

https://integration.uat.marley.ai/api/case/364ef9bb-fae5-4e2a-a746-cdca465a9c16

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The Case ID associated with the Hi Marley Case.	string	true	364ef9bb-fae5-4e2a-a746-cdca465a9c16	caseId exists within Hi Marley.

Optional Fields Breakdown

Property	Element	Description	Type	Example
caseData	claimNumber	Fields associated to claim/policy record.	string	"claimNumber": "0002383632"
	dateOfLoss		string	"dateOfLoss": "2022-05-25T16:00:00.000Z"
	policyNumber		string	"policyNumber": "Auto-21232"
	deductible		string	"deductible":"340"
	brand		string	"brand": "InsuranceBrand1"
	lineOfBusiness		string	"lineOfBusiness": { "type": "commerical", "subType": "auto" }
primaryContact	email	The email of the person assigned to the Hi Marley case.	string	"email": "joe.loop@insuranceco.com"
referenceId		The case reference identifier for the Hi Marley Case.	string	"referenceId": "0002383632"
privacy		The case privacy status. public private-redacted	enum	"privacy": "public"
languagePreference		The preferred language for the current Hi Marley case.	enum	"languagePreference": "en"
secondaryOperators (array)	email	The email of the person assigned to the Hi Marley case.	string	"email": "Linda.moon@insuranceco.com"

Request Payload Example

Note: This example shows are possible fields to update. In a real implementation, you should understand what changes you need in Hi Marley and only update the related fields. All other fields can be omitted.

{
    "caseData": {
        "claimNumber": "0002383632",
        "dateOfLoss": "2022-05-25T16:00:00.000Z",
        "policyNumber":"Auto-3989104u1jt",
        "deductible":"340",
        "brand": "InsuranceBrand1"
    },
    "primaryContact": {
        "email": "joe.loop@insuranceco.com"
    },
    "referenceId": "0002383632",
    "privacy": "public",
    "languagePreference": "en",
    "secondaryOperators": [
        {
            "email": "Linda.moon@insuranceco.com"
        }
    ]
}

API Response

Response: Case Response Structure

Common Errors to Handle

[404] Case Not Found - More Details

Update Case Data by ID