Skip to main content
PATCH
Update an AI Lead Finder Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

AI Lead Finder Agent ID

Example:

"01a0206f-e3f2-7716-a5df-27ff44ad9c99"

Body

application/json
name
string

Name of the agent

Required string length: 1 - 255
Example:

"Lead Finder - Outbound US"

campaign_id
string<uuid>

Reassign the agent to another campaign. A campaign can have at most one active agent.

Example:

"01a0206f-e3f2-7716-a5df-27ff44ad9c99"

search_filters
object

Audience search filters in the SuperSearch format. Unknown keys are rejected: the search would otherwise silently ignore them and return unfiltered results. Enum values are matched literally, including spacing.

Example:
min_active_leads
number

Threshold below which the agent tops up the campaign

Required range: 10 <= x <= 10000
Example:

50

on_exhaustion
enum<string>

What the agent does when the search runs out of new leads

Available options:
pause,
fallback,
broaden
Example:

"broaden"

fallback_search_filters
object | null

Audience search filters in the SuperSearch format. Unknown keys are rejected: the search would otherwise silently ignore them and return unfiltered results. Enum values are matched literally, including spacing.

Example:
show_one_lead_per_company
boolean

Deliver at most one lead per company in each top-up

Example:

true

ai_enrichment
object | null

AI enrichment columns filled on every top-up, keyed by output column name. Leads are held back until they are filled.

ai_enrichment_workflow
string

Workflow template the enrichment chain was loaded from — a built-in key or custom:<id>. Display-only.

Example:

"custom:0198c2a4-3f1e-7000-8000-000000000000"

Response

The updated AI Lead Finder Agent

An AI Lead Finder Agent

id
string<uuid>
required
read-only

Unique identifier for the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e72d746d00a"

organization_id
string<uuid>
required
read-only

Organization ID

Example:

"01a0206f-ab5d-7a94-b390-0e739ce03f39"

name
string
required

Name of the AI Agent

Example:

"Test AI Agent"

timestamp_created
string
required
read-only

Timestamp when the AI agent was created

Example:

"2026-08-20T18:29:44.413Z"

timestamp_updated
string
required
read-only

Timestamp when the AI agent was updated

Example:

"2026-08-20T18:29:44.413Z"

status
enum<number>
required

Status of the AI Agent

Available options:
-1,
0,
1
Example:

1

payload
object

Lead Finder Agent payload

type
null | enum<number>

Type of the AI Agent

Available options:
6
Example:

6

is_auto_created
null | boolean

Whether the AI agent was auto-created

Example:

false

created_by
null | string<uuid>
read-only

User ID who created the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e74994e2dba"

description
null | string
read-only

Description of the AI agent

Example:

"Optional agent description"