SDK method

tools.sourceProspects

Source prospects. Convenience alias for source_prospects, forwarding to tinbox.api.outreach.sourceProspects.mutate.

Signature

sourceProspects(input: Parameters<TinboxTools["sourceProspects"]>[0]): ReturnType<TinboxTools["sourceProspects"]>

Name	Type	Required	Description
`campaignId`	string	yes	The outreach campaign id.
`domains`	string[]	no	Explicit org apexes to qualify, e.g. ['acme.dev', 'globex.io'].
`contactsQuery`	string	no	A Contacts search (email/name) → their org apexes.
`dnsOnly`	boolean	no	DNS-only qualification (skip page scrapes — faster, no emails extracted).
`maxDomains`	number	no	Cap the candidate apexes qualified this call.
`skillId`	string	no	Source via a tenant agentic skill instead of the GTM qualifier (e.g. 'founder-spotter' to scrape Show HN). The skill returns the prospects.
`skillInput`	object	no	JSON input for the sourcing skill's run (e.g. { query, limit, minPoints }).

ReturnType<TinboxTools["sourceProspects"]>

await tinbox.tools.sourceProspects({
  "campaignId": "<campaignId>"
});