Get Contact

Description

This API allows you to retrieve a Contact by the Contact UUID generated on Contact Creation.

Service Name	Get Contact
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/contacts/:contactId
Production URL	https://integration.himarley.io/api/contacts/:contactId
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

API Request

Flow

1. Send API request with the required body parameters.
2. Hi Marley receives the request and matches  the user profile off of the required parameters sent.
3. Hi Marley updates the user object data.
4. Hi Marley responds with the user object data.

Request Example

https://integration.uat.marley.ai/api/contacts/154024a9-08ae-4d08-880f-dfd4c6a6df1b

API Response 

Response Payload Example

{
    "id": "0e2261fe-e05e-4049-b9d6-505a32272d42",
    "first": "Test",
    "last": "Name",
    "mobile": "[phone]",
    "optStatus": "OPTED_IN",
    "languagePreference": "en",
    "updatedAt": "2024-07-15T15:41:54.684Z",
    "createdAt": "2024-07-11T21:08:50.751Z"
}

Response Fields Breakdown

Property	Description	Type	Required	Example
id	The Hi Marley UUID generated for the Contact upon creation.	string UUID	true	"id": "0e2261fe-e05e-4049-b9d6-505a32272d42"
first	The given name for the Contact.	string	true	"first": "test"
last	The surname for the Contact.	string	true	"last": "name"
mobile	The mobile number for the Contact.	string	false	"mobile": "15552084238"
optStatus	The Contacts Opt Status.	enum	false	"optStatus": "OPTED_IN"
languagePreference	The language preference for the Contact.	enum	false	"languagePreference": "en"
updatedAt	The time stamp for when the Contact is updated.	dateTime	true	"updatedAt": "2024-07-15T15:41:54.684Z"
createdAt	The time tamp for when the Contact is created	dateTime	true	"createdAt": "2024-07-15T15:41:54.684Z"