v2

latestOpenAPI 3.0.3AGPL-3.0 license2026-07-2613501.9 MB

contacts

Create a lead-gen campaign

Create a campaign with optional agent context (markdown brief)..

post/contacts/campaigns

Request body

namestring required

Human-readable campaign name. Use a clear, descriptive title. Do NOT use slugs or technical IDs.

descriptionstring

Optional campaign description

draftMode'review' | 'autopilot'

Retained for compatibility only. Under the current model EVERY campaign drafts its outreach for the user to approve before anything is sent, regardless of this value — you normally do not set it.

languagestring

ISO 639-1 language code (e.g. 'fr', 'en'). Overrides ASCII heuristic for AI task language.

autopilotboolean

Opt in to LLM-backed agent tasks (qualification, drafting, outreach, connection-sending) on this campaign. For CHAT / interactive campaigns → ALWAYS pass autopilot: true so those agent tasks actually run. Omit or pass false ONLY when the caller is an API integration handling dispatch itself (deterministic action-only mode).

forceboolean

Bypass the duplicate-name guard. Normally the endpoint returns 409 with a suggested existing campaign when name is within Levenshtein 2 of one. Pass force: true after the agent has surfaced the suggestion to the user and they explicitly confirmed they want a second campaign with a similar name. Default: false.

Response

Campaign created

successtrue required

creditsUsedinteger required

Credits consumed by this call (always 0 for contacts queries).

retryAfterinteger required

Seconds to wait before next call of the same type (always 0 for contacts queries).