Built-in tool
Set up an outreach queue
Mark a List as an outreach queue and set its target depth, daily volume and readiness rules.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| listIdstring · required | string | required | The static People (or Companies) List to use as the outreach queue, from search-lists. |
| removeboolean · optional | boolean | optional | True to stop treating this List as an outreach queue. Its Records stay; only the queue rules and target are removed. |
| targetDaysstring · optional | string | optional | How many sending days of ready leads the queue should hold, at the daily volume. Null clears it. |
| dailyVolumestring · optional | string | optional | How many leads outreach uses per day (for LinkedIn, the sum of the sending accounts' daily connection-request limits from connector-get-sending-limits). Saved so status can compute days of cover without being told again. |
| reviewFieldstring · optional | string | optional | The Field that holds each lead's review result (its name or UUID, for example "ICP Fit"). A lead is ready only once this Field has a value. Null removes the review rule. |
| targetDepthstring · optional | string | optional | How many ready leads the queue should hold. Use this or targetDays; null clears it. |
| reviewPassValuesobject · optional | object | optional | The values of the review Field that pass (for example ["Great"]). Empty: any value passes. |
| excludeOtherQueuesboolean · optional | boolean | optional | Leave out anyone already queued in another outreach queue of this workspace. On by default. |
| recontactAfterDaysstring · optional | string | optional | Let a person contacted more than this many days ago count as ready again. Null (the default) never re-queues a contacted person. Someone who replied or is on do-not-contact is never ready. |
| onePersonPerCompanyboolean · optional | boolean | optional | Queue only one person per Company. Off unless asked. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success"
],
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string",
"description": "The List's name (same as listName), under the key a List result is titled by."
},
"error": {
"type": "string"
},
"listId": {
"type": "string"
},
"created": {
"type": "boolean",
"description": "True when this call made the List a queue."
},
"isQueue": {
"type": "boolean"
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
},
"listName": {
"type": "string"
},
"settings": {
"type": "object",
"required": [
"targetDepth",
"targetDays",
"dailyVolume",
"onePersonPerCompany",
"excludeOtherQueues",
"recontactAfterDays",
"reviewFieldId",
"reviewPassValues"
],
"properties": {
"targetDays": {
"type": [
"number",
"null"
],
"description": "Days of cover the queue should hold, when set in days (target = days x daily volume)."
},
"dailyVolume": {
"type": [
"number",
"null"
],
"description": "Leads outreach uses per day, as saved on the queue."
},
"targetDepth": {
"type": [
"number",
"null"
],
"description": "Ready leads the queue should hold, when set as a number."
},
"reviewFieldId": {
"type": [
"string",
"null"
]
},
"reviewPassValues": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeOtherQueues": {
"type": "boolean"
},
"recontactAfterDays": {
"type": [
"number",
"null"
],
"description": "After this many days a contacted person counts as ready again. Null: never."
},
"onePersonPerCompany": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}