Skip to main content
PATCH
/
api
/
leads
/
search
/
{id}
Update a lead search
curl --request PATCH \
  --url https://app.puffle.ai/api/leads/search/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>"
}
'
{
  "search": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "title_edited": true,
    "status": "pending",
    "filters": {},
    "apify_run_id": "<string>",
    "result_count": 4503599627370495,
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

​
Overview

Rename a lead search. The only editable field is title; setting it also flips title_edited = true, which prevents the auto-regeneration step on subsequent re-runs.
This operation shares the URL path /api/leads/search/{id} with other verbs. See the sibling page for related operations on the same resource.

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

Lead search UUID. Must be owned by the authenticated user.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Only title is editable.

​
title
string
required

Human-readable search title. Setting this flips title_edited = true on the row, permanently locking out future AI-driven title regeneration on re-runs.

Minimum string length: 1

Response

Search updated.

​
search
object
required

Canonical lead search entity.