Delete Operator by Email

Description

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

Service Name	Delete Operator by Email
Service Type	REST
Method	DELETE
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/user/actions/delete-operator/email/:email
Production URL	https://integration.himarley.io/api/user/actions/delete-operator/email/:email
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

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 email path parameter.
2. Hi Marley receives the request and validates the user exists; this is validated by checking if an existing email is present for that org.
3. Hi Marley responds with the user object data.

Request Example

https://integration.uat.marley.ai/api/user/actions/delete-operator/email/[e-mail]

Request Path Breakdown

Property	Description	Type	Required	Example	Validation
email	The email for the operator.	string	true	"[e-mail]"	The email exists within the org.

 

API Response 

Response Payload Example

{
    "id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1",
    "first": "stone",
    "last": "cold",
    "email": "[e-mail]",
    "mobile": "5552325555",
    "role": "operator"
}

 

Response Fields Breakdown

Element	Description	Type	Required	Example
id	The identifier generated and assigned to the operator.	string	true	"id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1"
first	The operators given name.	string	true	"first": "stone"
last	The operators surname.	string	true	"last": "cold"
email	The operators email address.	string	true	"email": "[e-mail]"
mobile	The operators mobile number.	int	false	"mobile": "5552325555"
role	The operators role. Will always be operator.	enum	true	"role": "operator"

Common Errors to Handle

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