Built-in tool
Check who was contacted or is on do-not-contact
Check in bulk whether People or Companies are on do-not-contact, already contacted or already replied, across every List and Workflow in the workspace.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| listIdstring · optional | string | optional | A static List UUID: every Record in it (up to 5000). Use it to check a whole send list, or to turn a "do not contact" List into do-not-contact state in one call. |
| recordIdsobject · optional | object | optional | People or Companies Record UUIDs (the _id values a Records search returns). At most 1000 per call. |
| identitiesobject · optional | object | optional | People or companies named without a Record: LinkedIn profile links, email addresses, or company website domains (a domain covers every address at it). At most 1000 per call. |
| onlyFlaggedboolean · optional | boolean | optional | Return only people who are on do-not-contact, contacted or replied. The summary still counts everyone. Default: |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success"
],
"properties": {
"code": {
"type": "string"
},
"error": {
"type": "string"
},
"checked": {
"type": "number"
},
"message": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"status"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"enum": [
"do_not_contact",
"replied",
"contacted",
"not_contacted"
],
"type": "string"
},
"identity": {
"type": "string"
},
"lastKind": {
"type": "string",
"description": "connection_request, message, inmail, voice_message, email, or what a manual mark named."
},
"recordId": {
"type": "string"
},
"repliedAt": {
"type": "string"
},
"lastChannel": {
"type": "string"
},
"contactCount": {
"type": "number"
},
"lastAccountId": {
"type": "string",
"description": "The sending account of the latest contact."
},
"lastWorkflowId": {
"type": "string",
"description": "The Workflow that sent the latest contact, when one did."
},
"lastContactedAt": {
"type": "string"
},
"firstContactedAt": {
"type": "string"
},
"doNotContactSetAt": {
"type": "string"
},
"doNotContactSetBy": {
"type": "string",
"description": "The person who set do-not-contact (user id)."
},
"doNotContactReason": {
"type": "string"
},
"doNotContactSetByName": {
"type": "string",
"description": "That person's name. When an agent set it, the person the agent was working for."
},
"doNotContactSetByAgent": {
"type": "string",
"description": "The agent that set do-not-contact (agent id)."
},
"doNotContactSetByAgentName": {
"type": "string",
"description": "That agent's name. Say both when telling someone who set it: \"set by <agent> for <person>\"."
}
},
"additionalProperties": false
}
},
"success": {
"type": "boolean"
},
"summary": {
"type": "object",
"required": [
"doNotContact",
"replied",
"contacted",
"notContacted"
],
"properties": {
"replied": {
"type": "number"
},
"contacted": {
"type": "number"
},
"doNotContact": {
"type": "number"
},
"notContacted": {
"type": "number"
}
},
"additionalProperties": false
},
"notFound": {
"type": "array",
"items": {
"type": "string"
},
"description": "Record ids that are not live People or Companies Records here, and identities that are not a LinkedIn link, an email address or a domain."
},
"partialList": {
"type": "boolean",
"description": "True when the List holds more than 5000 Records and only the first 5000 were read."
}
},
"additionalProperties": false
}