Description

The Send Survey Message API will send the Hi Marley survey to the customer mobile number associated to the Hi Marley Case ID passed in the request. The survey is a static Hi Marley survey asking the customer to first, rate their experience with Hi Marley and the Brand (Org Brand)- a 1 through 5 rating, as well as asking for feedback in response to their rating -what did we do well?

Service Name	Send Survey Message
Service Type	REST
Method	PUT
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/actions/send-survey/{caseId}
Production URL	https://integration.himarley.io/api/case/actions/send-survey/{caseId}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

API Request
API Response
- Response Payload Example
- Response Fields Breakdown
Common Errors to Handle
- [404] Case Not Found

API Request

Flow

Send API request with the path parameter of caseId.
Hi Marley receives requests and validates the CaseID exists for a Hi Marley case.
API Response received with a status: "IN_PROGRESS".
The customer receives the survey on their mobile number. (The mobile number associated with the Hi Marley case).

Request Example

https://integration.uat.marley.ai/api/case/actions/send-survey/8f4acac7-9e77-4cc6-a2a9-e18dfae3873b1

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-e18dfae3873b1	CaseID Exists

Survey received on customer mobile device

API Response

Response Payload Example

{
    "status": "IN_PROGRESS"
}

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
status		This API will respond with the status of "IN_PROGRESS" if the mobile number associated with the Hi Marley case is a sms enabled device, indicating the survey has been sent to the customer.	string	true	"status": "IN_PROGRESS"

Common Errors to Handle

[404] Case Not Found - More Details

Send Survey