INinstantly
AILeadFinderAgent

Pause an AI Lead Finder Agent

Changed on

Pause an AI Lead Finder Agent. A paused agent stops topping up its campaign until resumed.

Requires one of the following scopes: ai_agents:update, ai_agents:all, all:update, all:all

post/api/v2/ai-agents/lead-finder/{id}/pause

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/lead-finder/{id}/pause
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6d-8581-7b99-9ed4-69e24e377fed

AI Lead Finder Agent ID

Response

The paused AI Lead Finder Agent

idstring uuid required

Unique identifier for the AI agent

organization_idstring uuid required

Organization ID

namestring required

Name of the AI Agent

type6 nullable

Type of the AI Agent

timestamp_createdstring required

Timestamp when the AI agent was created

timestamp_updatedstring required

Timestamp when the AI agent was updated

status-1 | 0 | 1 required

Status of the AI Agent

is_auto_createdboolean nullable

Whether the AI agent was auto-created

created_bystring uuid nullable

User ID who created the AI agent

descriptionstring nullable

Description of the AI agent

Example response

{
  "id": "01a19e6d-50a9-79e8-8f91-951a76adc9d7",
  "organization_id": "01a19e6d-50a9-79e8-8f91-951b651b4747",
  "name": "Test AI Agent",
  "payload": {
    "campaign_id": "01a19e6d-50a9-79e8-8f91-951864a8ae03",
    "campaign_name": "Outbound US",
    "min_active_leads": 50,
    "on_exhaustion": "pause",
    "ai_enrichment_workflow": "custom:0198c2a4-3f1e-7000-8000-000000000000"
  },
  "type": 6,
  "timestamp_created": "2026-11-02T22:42:06.633Z",
  "timestamp_updated": "2026-11-02T22:42:06.633Z",
  "status": 1,
  "created_by": "01a19e6d-50a9-79e8-8f91-951cd6f29219",
  "description": "Optional agent description"
}

Changes