Skip to content

[Bug Report: API Field Missing] contacts/search endPoint not returning dndSettings #43

Open
@cimborrio5

Description

@cimborrio5

🐛 Describe the Bug

I'm using API v2 with base_url = services.leadconnectorhq.com
The API endpoint contacts/search in the documentation (https://highlevel.stoplight.io/docs/integrations/dbe4f3a00a106-search-contacts) should be returning dndSettings field which is an object.
I have modified a contact with the objects/id PUT method in order to add this information and if I use the endpoint to GET the contact, the response includes "dndSettings" (see image for capture of Postman GET contact)
But when I use the contacts/search POST method to retrieve contact information, even when documentation defines dndSettings is part of the response, this field is not present (even with field "dnd" to value true).
See image for capture of Postman POST contacts/search.

📍 API Endpoint

/contacts/search

✅ Expected Behavior

The API should return a response as defined in the documentation .
This is what appears in documentation https://highlevel.stoplight.io/docs/integrations/dbe4f3a00a106-search-contacts, in the "Response example" including this dndSettings:
{
"contacts": [
{
"id": "102goXVW3lIExEQPOnd3",
"phoneLabel": "Mobile",
"country": "United States",
"address": "123 Main Street",
"source": "Website",
"type": "lead",
"locationId": "502goXVW3lIExEQPOnd3",
"dnd": false,
"state": "California",
"businessName": "Acme Corporation",
"customFields": [
{
"id": "MgobCB14YMVKuE4Ka8p1",
"value": "name"
}
],
"tags": [
"tag-1",
"tag-2"
],
"dateAdded": "2024-06-06T18:54:57.221Z",
"additionalEmails": [
"john@example.com",
"jane@example.com"
],
"phone": "+123456789",
"companyName": "XYZ Corp",
"additionalPhones": [
"123456789",
"987654321"
],
"dateUpdated": "2024-06-06T18:54:57.221Z",
"city": "New York",
"dateOfBirth": "1990-01-01",
"firstNameLowerCase": "john",
"lastNameLowerCase": "doe",
"email": "john@example.com",
"assignedTo": "182goXVW3lIExEQPOnd3",
"followers": [
"682goXVW3lIExEQPOnd3",
"582goXVW3lIExEQPOnd3"
],
"validEmail": true,
"dndSettings": {
"Call": {
"status": "active",
"message": "string",
"code": "string"
},
"Email": {
"status": "active",
"message": "string",
"code": "string"
},
"SMS": {
"status": "active",
"message": "string",
"code": "string"
},
"WhatsApp": {
"status": "active",
"message": "string",
"code": "string"
},
"GMB": {
"status": "active",
"message": "string",
"code": "string"
},
"FB": {
"status": "active",
"message": "string",
"code": "string"
}
},
"opportunities": [
{
"id": "1a2b3c4d5e6f7g8h9i0j",
"pipeline_id": "pipeline123",
"pipeline_stage_id": "stage456",
"monetary_value": 10000,
"status": "open"
}
],
"postalCode": "12345",
"businessId": "282goXVW3lIExEQPOnd3",
"searchAfter": [
1234,
"102goXVW3lIExEQPOnd3"
]
}
],
"total": 120
}

💻 Screenshots or Code Samples

Image

Image

Product Area

contacts

🧠 Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bug-missing-api-fieldSomething isn't working in the Highlevel API or fields are missing in the API Endpoints.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions