Delete Scheduled Message

Description

The Schedule Message API allows you to schedule messages for a future send to a Hi Marley case from any system.

Service Name	Delete Scheduled Message
Service Type	REST
Method	DELETE
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/cases/:caseId/scheduled-messages/:messageId
Production URL	https://integration.himarley.io/api/case/:caseId/scheduled-messages/:messageId

Table of Contents

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

API Request

Flow

1. Send API Request with Hi Marley caseId,and messageId from your system.
2. Hi Marley receives requests and validates existing case and pending scheduled message.
3. API Response received with either success or error message based on validation. Success indicates that scheduled message will no longer be sent.

 

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
messageId		The ID associated with the pending scheduled message. Returned as payload of scheduled message API.	string	true	ee65ad7c-44b8-4e30-8a6b-0e3face460e5	MessageId exists within Hi Marley and is associated with the caseId

 

API Response 

The API response has an empty response body for a 200 success status. 

Common Errors to Handle

• [404] Case Not Found - More Details