Description

The Query Contact API allows carrier customers to query contacts from their claims or policy systems directly into Hi Marley.

It enables seamless search, improving operational efficiency and customer interactions.

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

API Request

Request Example

Contacts can be queried by the contactId, mobile, or email.

https://integration.uat.marley.ai/api/contacts/query

{
    "id": "463d5a15-655d-49dd-b698-cdaa1b7c5518",
    "mobile": "+14012744005",
    "email": "test-email@himarley.com"
}

Request Field Breakdown

Property	Description	Type	Required	Example	Validation
id	The Hi Marley UUID generated for the Contact upon creation.	string	false	"id": "463d5a15-655d-49dd-b698-cdaa1b7c5518"
mobile	The mobile number for the Contact.	string	false	"mobile": "+14012744005"
email	The email for the contact.	string	false	"email": "test-email@himarley.com"

Response Payload Example

{
    "data": [
        {
            "id": "a6998909-7528-476b-b9e3-3c55b558d1af",
            "first": "Test",
            "last": "Name",
            "languagePreference": "en",
            "updatedAt": "2024-10-08T02:49:10.914Z",
            "createdAt": "2024-10-08T02:49:10.914Z",
            "email": "test-email@himarley.com",
            "mobile": "+15552329941",
            "optStatus": "PENDING_OPT_IN"
        }
    ],
    "pagination": {
        "count": 1,
        "currentPage": "/contacts/query?pageSize=10&page=1",
        "totalPages": 1,
        "pageSize": 10,
        "nextPage": null,
        "prevPage": null
    }
}

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"
email	The email for the Contact	email	false	"email": "test-email@himarley.com"

Query Contacts