Skip to content

ContactSearchResponse

Result of a connector-backed CRM contact search.

Properties

Property Type Required Description
successful boolean Yes Whether the connector completed the lookup successfully.
returnMessage ReturnMessage No
contact array of ContactInfo No Matched contacts. The legacy property name is singular even though its value is an array and can include a synthetic create-new choice.

Example

{
  "successful": false,
  "returnMessage": {
    "message": "string",
    "messageType": "string",
    "ttl": 0,
    "details": [
      {}
    ]
  },
  "contact": [
    {
      "id": "string",
      "name": "string",
      "phone": "string",
      "phoneNumber": "string",
      "type": "string",
      "title": "string",
      "company": "string",
      "email": "string",
      "createdDate": "string",
      "mostRecentActivityDate": "string",
      "additionalInfo": {},
      "isNewContact": false
    }
  ]
}