Delete Operator by ID

Description

This API will delete an Operator from Hi Marley by passing the operators email in the request.

Service Name	Delete Operator by ID
Service Type	REST
Method	DELETE
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/operators/:id
Production URL	https://integration.himarley.io/api/v2/operators/:id
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

View technical documentation with sample request and response payloads hosted on SwaggerHub.

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request with the operator ID path parameter.
2. Hi Marley receives the request and validates the user ID exists.
3. Hi Marley responds with the user object data.

Request Example

https://integration.uat.marley.ai/api/v2/operators/14db69c0-af9c-41a4-a9e9-403d4b6898ae1

Request Path Breakdown

Property	Description	Type	Required	Example	Validation
ID	The unique identifier for the operator.	string	true	14db69c0-af9c-41a4-a9e9-403d4b6898ae1	The unique identifier exists within the org.

 

API Response 

Response Code: 204

Common Errors to Handle

• Data Validation Error [400]: Should have required Property.