Create a list
create_listExport the places of a search into a new list, with their contact details (up to 50,000 rows). Price: 1 credit per place never delivered to this account (Agency: included under fair use); withEmail: only places with an email address (found ones first, then guessed and verified ones); verifyEmails: plus 1 credit per address verified. maxCredits is never exceeded: send the "cost" of estimate_list, once the user agreed. One export at a time per account. While the list says "creating", follow it with get_list.
Paid: maxCredits (the most credits this call may spend, never exceeded) and idempotencyKey (a new UUID v4 for this operation) are required; without them nothing runs. To retry after an error or a timeout, send the same idempotencyKey with the same arguments: nothing is charged twice. Ask the user before calling it.
Same call as POST /api/v1/lists of the REST API.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"search": "<search>",
"maxCredits": "<maxCredits>",
"idempotencyKey": "<idempotencyKey>"
},
"name": "create_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | List name, as shown in "My lists". | |
| rows | No | Rows wanted (at most 50000). With withEmail: email addresses wanted. Required unless wholeArea is true. | |
| search | Yes | The search, as returned by /categories/suggest (then narrowed with /areas, filters…). The "search" object returned by suggest_categories (target, area, filters, sort), sent as is or edited; its full schema is the "search" input of count_search. An invalid search is refused with invalid_request and the fields to fix. | |
| wholeArea | No | Rarely searched area only (estimate returned kind "zone"): fill the list with the whole area instead of a number of rows. | |
| withEmail | No | true = the "With email" choice of the app: places with an email address only; found addresses are delivered first, others are guessed on the websites then checked (1 credit per valid address), and the verification of the addresses is reserved at creation (1 credit per address, unused credits returned). | |
| maxCredits | Yes | The most credits this call may spend (required on every paid call, with an Idempotency-Key header). Never exceeded. | |
| verifyEmails | No | true = the "Verify emails" box of the app: the addresses this list delivers are verified (deliverable, risky, undeliverable), 1 credit per address, reserved at creation and inside maxCredits (send maxCredits ≥ export cost + rows); unused credits are returned. Up to 10000 rows; not for rarely searched areas; included in withEmail lists. | |
| idempotencyKey | Yes | A new UUID v4 for this operation (sent as the Idempotency-Key of the API). Reuse it only to retry the very same call: the saved result comes back, nothing is charged twice. |