Built-in tool
Set do-not-contact or mark people contacted
Mark People or Companies as contacted or replied, or set or clear do-not-contact, for the whole workspace and in bulk.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| actionstring · required | string | required | mark_contacted / mark_replied: record outreach or a reply that happened outside Connie. set_do_not_contact: nobody in this workspace may contact them (every send is refused). clear_do_not_contact: lift it, only when the person who set it or the recipient asked. clear_contacted: undo a contacted or replied mark recorded by mistake. One of: |
| 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. |
| reasonstring · optional | string | optional | Why, in a few words. Required for set_do_not_contact (for example "unsubscribed", "competitor", "existing client"). |
| accountstring · optional | string | optional | For mark_contacted: the sending account, as a name or address. |
| channelstring · optional | string | optional | For mark_contacted / mark_replied: where it happened. One of: |
| 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. |
| occurredAtstring · optional | string | optional | For mark_contacted / mark_replied: when it happened (ISO 8601). Defaults to now. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success"
],
"properties": {
"code": {
"type": "string"
},
"error": {
"type": "string"
},
"action": {
"type": "string"
},
"changed": {
"type": "number",
"description": "How many people or companies the change was recorded for."
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
},
"notFound": {
"type": "array",
"items": {
"type": "string"
}
},
"undoWith": {
"type": "string",
"description": "The action of this same tool that reverses the change, with the same recordIds, identities or listId."
},
"recordedBy": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"agentId": {
"type": "string"
}
},
"description": "Who the change is recorded under in the contact history: the agent that made it, and the person it was working for.",
"additionalProperties": false
},
"partialList": {
"type": "boolean"
}
},
"additionalProperties": false
}