Inspect the status of a lead search — the primary polling target after kicking off a search.
createLeadSearch — watch status transition through pending → running → completed (or failed).
/api/leads/search/{id} with other verbs. See Update a lead search to rename, or Delete a lead search to remove.createLeadSearch:| Status | Cadence |
|---|---|
pending | every 5 s |
running | every 5 to 10 s |
completed | stop polling — fold results into a list via add-to-list |
failed | stop polling — surface error_message to the human |
correlationId, and escalate.Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Lead search UUID. Must be owned by the authenticated user.
^([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)$Lead search state.
Canonical lead search entity.