Rename Lead Finder List

Rename a list.

PATCHhttps://api.foxreach.io/api/v1/lead-finder/lists/{list_id}

Requires an API key with the write scope.

Path Parameters#

list_idstringpathrequired

The list id.

Body Parameters#

namestringbodyrequired

New name, 1 to 200 characters.

Response#

dataobject

Show data

idstring

List identifier.

namestring

List name.

kindstring

people or companies.

itemCountinteger

Items in the list.

createdAtstring

ISO 8601 timestamp.

updatedAtstring

ISO 8601 timestamp.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`404`	`Lead Finder is not enabled` while Lead Finder is switched off on this environment
`503`	`Lead Finder is not configured` when it is enabled but has no data provider key
`404`	`List not found`: the list does not exist in this workspace

Rate Limit#

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X PATCH "https://api.foxreach.io/api/v1/lead-finder/lists/lst_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q4 CTOs"}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.lead_finder.rename_list("lst_abc123", "Q4 CTOs")

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.leadFinder.renameList("lst_abc123", { name: "Q4 CTOs" });

Response

JSON

{
  "data": {"id": "lst_abc123", "name": "CTOs to reveal", "kind": "people", "itemCount": 0, "createdAt": "2026-11-04T10:00:00+00:00", "updatedAt": "2026-11-04T10:00:00+00:00"}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026