Lead sources
Choose an action to read its inputs, results, and usage guidance. Your connection determines which tools are available to you.
Lead sources record how businesses and Deals arrive in your Portal and can determine the intake application future businesses receive.
Configure a Lead source
- List sources with
source_channels.list, then read the selected source withsource_channels.get. - Create a business-signup-link or Referral API source with
source_channels.createwhen needed. - Read the latest revision before changing its details or configuring intake.
- Review the setup before using it for future clients. Existing businesses, applications, and Deals are not rewritten.
In-house and Marketplace sources are created by the system; partner sources come from partnerships. A Deal Package defines the application and delivery setup for new Deals.
Remove a Lead source
When the user asks to remove a source, use source_channels.get_removal_options to check eligibility and affected counts. A signup source with activity needs a replacement chosen by the user. Removing it moves business and Deal attribution to that replacement, changing how reports group the activity; the businesses and Deals remain.
Use source_channels.review_removal with the chosen replacement, explain the returned effects, and obtain a second explicit confirmation. Then call source_channels.remove with the unchanged review token, revision, replacement, and user_confirmed: true. Reviews expire after ten minutes or when the reviewed source, activity, or replacement changes. Reuse client_request_id only for an identical retry, including a completed removal.
An unused Referral API source can be removed; this revokes its source-owned API credentials. API sources with attributed businesses or Deals cannot be removed. Signup links for a removed source should no longer be used. System sources cannot be removed, and partnership sources are managed through the Partnership tools.
You can also remove an eligible source in your Portal. Credential management remains on the source’s Portal page. Confirmation does not grant additional Portal permissions.
Available tools
source_channels.listList Lead sourcessource_channels.getGet Lead sourcesource_channels.createCreate Lead sourcesource_channels.review_removalReview Lead source removalsource_channels.configure_intakeConfigure Lead source intakesource_channels.get_activity_summaryGet Lead source activity summarysource_channels.get_removal_optionsGet Lead source removal optionssource_channels.removeRemove Lead sourcesource_channels.updateUpdate Lead source