save_prospect
Save one opportunity by a stable externalRef without checking, spending check credits or enrolling monitoring. A publisher-only opportunity needs an exact source page before verification.
Name recorded in the 2026-10-27 deployment. This page describes current source; verify inputs and access in your connected catalog. Provider configuration and workspace access still apply.
This operation reads or updates saved campaign records with the contacts capability enabled. It starts no verification, schedule, message or sequence and consumes no checking credits.
Example request
Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.Returned result
Schema-validated example; IDs and dates are illustrative. MCP returns this data instructuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.
Full response example
Full response example
Input fields
Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.Validation and omitted values
Save a publisher or exact source page for one website. Use revision 0 and a stable opaque externalRef from your source record. Saving creates no check job, spends no check credits and starts no recurring monitoring. An unknown source page needs publisherUrl; the returned sourceUrl is null and sourceKind is publisher. Supply an exact sourceUrl when known. The source and publisher must share an origin. Saved prospects share the workspace link/prospect allowance. One canonical record counts once when monitoring starts. An occupied placement or ambiguous source reference refuses creation; records are never silently merged. Identical saved content at the same externalRef returns the existing record. After an uncertain response, read list_prospects with externalRef and view all before changing inputs. Use update_prospect for later edits. Sender and source CRM records remain unchanged.Defaults when omitted
Output fields
Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.prospect(object, required).replayed(boolean, required): True when the response reuses an earlier request with the same idempotency value.
All fields and nested objects
All fields and nested objects
Types, allowed values, limits and nested fields:
Errors and retries
This write is annotated idempotent without a caller-supplied idempotency key. Reconcile saved state after an uncertain response, then use the same inputs for the same intended operation. Do not add an unsupported key. Operation-specific errors includeUNAUTHORIZED, INSUFFICIENT_SCOPE, CAMPAIGNS_NOT_READY, PROSPECT_ACCESS_DENIED, INVALID_PROSPECT_INPUT, PROSPECT_PUBLISHER_REQUIRED, PROSPECT_REFERENCE_CONFLICT, PROSPECT_REVISION_CONFLICT, PROSPECT_PLACEMENT_CONFLICT, WATCH_QUOTA_EXCEEDED.
See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.