v2

latestOpenAPI 3.0.3AGPL-3.0 license2026-07-2613501.9 MB

contacts

Update campaign settings

Update campaign name, description, context, schedule, limits, or daily targets. NEVER pass status here — the server rejects it; use campaign_transition for start/pause/resume/complete/reset..

patch/contacts/campaigns/{campaignId}

Path parameters

campaignIdstring required

Campaign ID

Request body

namestring

descriptionstring

scheduledStartTimestring

scheduledStopTimestring

timezonestring

runDaysstring[]

Days the campaign runs user-action tasks. Use lowercase day names (e.g. monday, tuesday); pick at least one.

dailyActionLimitinteger nullable

dailyTargetinteger nullable

totalTargetinteger nullable

disabledTaskTypesstring[]

Task types to disable (e.g. ['discover-qualify', 'outreach-draft', 'connect-send']). Set to [] to re-enable all.

draftMode'review' | 'autopilot'

review: all agent actions create drafts for user approval. autopilot: agent sends directly without review.

autopilotboolean

Enable or disable LLM-backed agent tasks (qualification, drafting, outreach) for this campaign. false disables all AI tasks even if the user has keys configured.

languagestring

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

qualifyThresholdinteger

Response

Campaign updated

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).