Opt Status - By User ID

Description

Returns the user's opt status using their ID.

Service Name	Opt Status - User by ID
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/user/actions/status/id/{id}
Production URL	https://integration.himarley.io/api/user/actions/status/id/{id}
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 ID.
2. Hi Marley receives the request and validates the customer ID exists.
3. Hi Marley returns the Opt Status of the user.

Request Example

https://integration.uat.marley.ai/api/user/actions/status/id/81f45989-c62d-4544-93a5-fd8b5f9936e71

 

Request Path Breakdown

Property	Description	Type	Required	Example	Validation
ID	The UUID of the end-user.	string	true	81f45989-c62d-4544-93a5-fd8b5f9936e71	ID number 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

User Not Found Error