For the complete documentation index, see llms.txt. This page is also available as Markdown.

Copilot

Launch a draft outbound campaign and start lead finding

post

Creates a DRAFT Emailchaser campaign (with its email sequence) scoped to the caller's workspace and kicks off Sales Navigator lead extraction. The campaign stays in DRAFT — nothing sends automatically.

Authorizations
AuthorizationstringRequired
Body
namestringRequired

Name is the campaign name.

Example: Acme outbound Q3
salesNavDatastringOptional

SalesNavData is the optional base64 browser-extension payload that carries the LinkedIn session required to actually run the search. When omitted the lead engine cannot authenticate to LinkedIn (see docs), so provide it to start real extraction.

salesNavSearchUrlstringRequired

SalesNavSearchURL is the LinkedIn Sales Navigator search URL the lead engine should extract leads from.

Example: https://www.linkedin.com/sales/search/people?...
Responses
202

Draft campaign created and lead finding started

application/json
campaignIdintegerOptionalExample: 1234
jobIdstringOptionalExample: 5678
messagestringOptionalExample: draft campaign created; lead finding started
statusstringOptionalExample: draft
post/copilot/launch

Plan an outbound campaign from a website (read-only)

post

Fetches the company website, infers an Ideal Customer Profile with the managed AI model, and drafts a suggested cold-email sequence. Creates nothing.

Authorizations
AuthorizationstringRequired
Body
contextstringOptional

Context is optional extra guidance from the caller (e.g. "we sell to dentists in the US").

Example: we sell to dental clinics in the US
websitestringRequired

Website is the company homepage to analyse (with or without scheme).

Example: https://acme.com
Responses
200

Suggested ICP and sequence

application/json
post/copilot/plan

Last updated