campaigns

Create campaign

Transport: call this endpoint with HTTP POST and a JSON request body. Create a draft campaign. This does not start outbound sending. Public REST campaign creation does not require a launch-campaign skill_run_id; the skill receipt remains an MCP creation requirement. Enrollment defaults to enrollment_mode='fixed'. Explicitly set enrollment_mode='continuous' when the campaign must accept future targets while active. Send enrollment_mode as a TOP-LEVEL field, not inside settings — a nested value is ignored, the campaign silently defaults to fixed, and the response returns a warning. A continuous campaign still needs executable shared campaign-level content at creation; after activation, campaigns.addTargets can admit new recipients with their own approval-bound personalized_steps snapshots. enrollment_mode='continuous' is now supported together with settings.personalization_mode='personalized': later recipients can each carry their own per-lead sequence (a distinct ordered set of steps) in addition to per-lead copy. This is additive and backward-compatible. The response returns status='draft', effective enrollment_mode, targets_editable, add_targets_method='campaigns.addTargets', and next_action so a human or agent can continue without relying on external docs. To launch the draft, call confirmations.requestAction with action_type='campaign_activate' and payload={campaign_id}, then call campaigns.updateStatus with status='active' and the approved confirmation_id.

post/v1/campaigns/create

Request

  • Base URL: https://api.zevari.ai
  • URL: https://api.zevari.ai/v1/campaigns/create
  • Auth: HTTP bearer

Request body

namestring required

Campaign name

campaign_type'warm_up' | 'outreach' | 'content' | 'custom' required

Campaign type

goalstring

Campaign goal (e.g. book_meeting, start_conversation). Falls back to user's default CTA goal.

goal_customstring

Custom goal text when goal is 'other'

resource_urlstring

Resource URL for campaign CTA (e.g., calendar link)

settingsobject

Campaign settings (working_hours, timezone, stop_on_reply, etc.)

skill_run_idstring

Required for MCP-created campaigns. Call skills_get with slug='launch-campaign' first and pass the returned skill_run_id.

enrollment_mode'fixed' | 'continuous'

Recipient policy. Send this as a TOP-LEVEL parameter — a value nested inside settings is ignored and the campaign silently defaults to 'fixed'. Omit for the default 'fixed', which preserves the approved target set. 'continuous' authorizes one-call additions while active; new targets are validated and scheduled without pausing existing execution.

Response

Draft campaign created. The response describes how to add targets and what to do next.

okboolean required

False when the underlying tool reports an error or a partial failure.

methodstring required

Public API method name.

dataunknown required
request_idstring required

Request correlation ID. Also returned in X-Zevari-Request-Id.

Example response

{
  "method": "campaigns.delete"
}

Changes

No recorded changes to this operation across all 1 revision of this API.