create_auto_search
Creates an Auto Search and starts it: every day new people matching the preferences are verified and added to the website's leads, 1 credit per lead delivered, up to perDay a day, until it is paused.
Create an Auto Search · Changes data · Spends credits or money
Creates an Auto Search and starts it: every day new people matching the preferences are verified and added to the website's leads, 1 credit per lead delivered, up to perDay a day, until it is paused. Must preferences are required, the others raise the score. Confirm the preferences and the daily amount with the user before calling. Returns the saved Auto Search. Returns 403 when the plan does not include Prospector.
| Connection | Account URL, team member URL or OAuth |
|---|
Parameters
| Parameter | Type | Required | Accepts | Description |
|---|---|---|---|---|
websiteId | string | Yes | any | Website ID from list_websites. |
name | string | Yes | any | A short name, e.g. 'US SaaS founders'. |
description | string | No | any | Optional. The plain-English description it was built from. |
prefs | object[] | Yes | any | Preferences from build_auto_search_profile: field (job, seniority, department, industry, emp, revenue, funding, round, tech, hq), values, weight (Must, High, Prefer, Bonus). |
prefs[].field | string | Yes | 10 values | What the preference is about: job (job title), seniority, department, industry, emp (employees), revenue, funding, round (funding round), tech (technology used) or hq (company headquarters country). |
prefs[].values | string[] | Yes | any | The values that match, e.g. ["CEO", "Founder"] for job or ["United States"] for hq. |
prefs[].weight | string | No | Must, High, Prefer, Bonus | Must (required), High, Prefer or Bonus (raise the score). Default Prefer. |
excludes | object[] | No | any | Optional. Companies or people to leave out: field cname (company name), domain or pname (person name), values. |
excludes[].field | string | Yes | cname, domain, pname | cname (company name), domain (company domain) or pname (person name). |
excludes[].values | string[] | Yes | any | The names or domains to leave out. |
perDay | number | No | 25, 50, 100, 200, 500 | Leads per day: 25, 50, 100, 200 or 500. Default 100. |
Accepted values
The exact values these fields take; anything else is refused.
prefs[].field
job · seniority · department · industry · emp · revenue · funding · round · tech · hq
Tool definition
What your assistant receives from tools/list:
{
"name": "create_auto_search",
"title": "Create an Auto Search",
"annotations": {
"title": "Create an Auto Search",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false
},
"inputSchema": {
"type": "object",
"properties": {
"websiteId": {
"type": "string",
"description": "Website ID from list_websites."
},
"name": {
"type": "string",
"description": "A short name, e.g. 'US SaaS founders'."
},
"description": {
"type": "string",
"description": "Optional. The plain-English description it was built from."
},
"prefs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"job",
"seniority",
"department",
"industry",
"emp",
"revenue",
"funding",
"round",
"tech",
"hq"
],
"description": "What the preference is about: job (job title), seniority, department, industry, emp (employees), revenue, funding, round (funding round), tech (technology used) or hq (company headquarters country)."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The values that match, e.g. [\"CEO\", \"Founder\"] for job or [\"United States\"] for hq."
},
"weight": {
"type": "string",
"enum": [
"Must",
"High",
"Prefer",
"Bonus"
],
"description": "Must (required), High, Prefer or Bonus (raise the score). Default Prefer."
}
},
"required": [
"field",
"values"
]
},
"description": "Preferences from build_auto_search_profile: field (job, seniority, department, industry, emp, revenue, funding, round, tech, hq), values, weight (Must, High, Prefer, Bonus)."
},
"excludes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"cname",
"domain",
"pname"
],
"description": "cname (company name), domain (company domain) or pname (person name)."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The names or domains to leave out."
}
},
"required": [
"field",
"values"
]
},
"description": "Optional. Companies or people to leave out: field cname (company name), domain or pname (person name), values."
},
"perDay": {
"type": "number",
"enum": [
25,
50,
100,
200,
500
],
"description": "Leads per day: 25, 50, 100, 200 or 500. Default 100."
}
},
"required": [
"websiteId",
"name",
"prefs"
]
}
}Used in
build_auto_search_profile
Turns a plain-English description of the ideal customer ("founders of US SaaS companies with 10-200 staff") into Auto Search preferences: field, values and weight (Must, High, Prefer or Bonus).
pause_auto_search
Pauses one Auto Search: no more leads are delivered and no more credits are used until it is resumed.