Opt Out User by Email

Description

Opts user out of future communication on the Marley platform using their email address. To communicate with this user via Marley in the future their representative will have to communicate that they will need to text START back into the Marley number.

Service Name	Opt Out - User by Email
Service Type	REST
Method	PUT
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/user/actions/optout/email/{email}
Production URL	https://integration.himarley.io/api/user/actions/optout/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 path parameter of the customer email.
2. Hi Marley receives the request and validates the customer email exists.
3. Hi Marley Opts the user out of sms communication, resulting in blocked messaging via the Hi Marley webapp and messaging APIs.
4. Hi Marley responds with the customer object data.

Request Example

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

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
email		The email associated with the customer user profile within Hi Marley.	string	true	[e-mail]	email exists within a customer user profile within Hi Marley.

 

API Response 

Response Payload Example

{
    "id": "bc13bc97-23eb-40eb-ac0f-12341ee99aae",
    "first": "james",
    "last": "bondd",
    "email": "[e-mail]"
    "mobile": "[phone]",
    "role": "enduser",
    "optStatus": false,
    "optStatusDetail": "OPTED_OUT"
}

 

Response Fields Breakdown

Element	Description	Type	Required	Example
id	The identifier generated and assigned to the customer.	string	true	"id": "bc13bc97-23eb-40eb-ac0f-12341ee99aae"
first	The customers given name.	string	true	"first": "james"
last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "bondd"
email	The customers email address.	string	false	"email": "[e-mail]
mobile	The customers mobile number.	int	true	"mobile": "[phone]"
role	The customers role. Always set to enduser.	enum	true	"role": "enduser"
optStatus	The current opt status for the customer.	boolean	true	"optStatus": false
optStatusDetail	Description of the current opt status for the customer.	string	true	"optStatusDetail": "OPTED_OUT"

Common Errors to Handle

• [404] Case Not Found - More Details