Opt Status - By User Email

Description

Returns up the user's opt-in opt-out status using their email.

Service Name	Opt Status - User by Email
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/user/actions/status/email/{email}
Production URL	https://integration.himarley.io/api/user/actions/status/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 returns the Opt Status of the user.

Request Example

https://integration.uat.marley.ai/api/user/actions/status/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

{
    "optStatus": false,
}

 

Response Fields Breakdown

Element	Description	Type	Required	Example
optStatus	The current opt status for the customer. true = opted in. false = opted out.	boolean	true	"optStatus": false

Common Errors to Handle

• [404] Case Not Found - More Details