Campaign

Campaigns: one Sequence run for the Leads of your Team's Lead lists, from its sending Accounts, paced on a schedule. Create and edit drafts, preview, start, pause, resume, archive, add or remove Leads; lint a Sequence and write a template offline; upload the audio of a voice note step (curviate campaign voice-clip). Your Team's data: every role reads; writes need send access to each sending Account, and Campaigns need the Automate plan.

Before you start: an API key and a connected LinkedIn account, see the Quickstart.

Commands

CommandDescription
curviate campaign listList your Team's Campaigns, most recently updated first (--sort activity: latest activity first, last_activity_at). Items carry no Sequence: read one with curviate campaign get <campaign_id>. A cursor belongs to its sort.
curviate campaign getOne Campaign with its current Sequence and lint warnings. With --version, that Sequence version instead, and how many Enrollments still run on it.
curviate campaign createCreate a Campaign from a Campaign file, always as a draft: nothing runs until curviate campaign start. The file is checked before anything is sent, its Sequence as curviate campaign lint checks it. settings.priority (normal or prioritized) sets the Campaign's weight in each Account's budgets: 1 or 1.5, on every budget; every Campaign with work due still progresses and no limit is passed. Needs Automate.
curviate campaign updateChange a Campaign from a Campaign file: objects (schedule, settings) merge by key, arrays and the Sequence replace whole, null clears. settings.priority (normal or prioritized) weighs the Campaign 1 or 1.5 in each Account's budgets, on every budget (every Campaign with work due still progresses, and no limit is passed); settings.new_enrollments_per_account_per_day and settings.assign even are retired (accepted and ignored until 2027-01-28, with a notice). After start, a structural Sequence change makes a new version; running Enrollments keep theirs. With --if-revision the save is refused when someone saved the Sequence since. Needs Automate.
curviate campaign startStart a draft: scheduled when its start time is ahead, else active. Freezes Sequence version 1. A Campaign missing what it needs is refused with every gap listed. Needs Automate.
curviate campaign pausePause an active or scheduled Campaign: no Step runs until it is resumed. Waits keep their time.
curviate campaign resumeResume a paused Campaign. Runs the start checks again. Needs Automate.
curviate campaign archiveArchive a Campaign: its open Enrollments end (campaign_archived) and it never runs again.
curviate campaign deleteDelete a draft Campaign with its Sequence versions. Any other status: archive it instead.
curviate campaign previewWhat the Campaign would do, in any status: every path through its Sequence, rendered messages for sampled or named Leads, and the budget projection: per Account the pool that binds its pace, the expected actions a day (a draft: the mean daily invitations, messages and InMails of the first 7 days of its forecast, as if turned on now), and warnings (hours_below_share, no_sending_account). A read: never reaches LinkedIn, spends nothing.
curviate campaign addEnroll Leads directly, on an Account of the Campaign (--account) or one Curviate assigns. Every exclusion and filter applies; each Lead's outcome says what happened. Sent in requests of up to 1000 ids, in order. Needs Automate.
curviate campaign removeTake Leads out of the Campaign: their open Enrollments end (removed). Sent in requests of up to 1000 ids, in order.
curviate campaign lintCheck a Sequence offline with the rules the API applies: a Campaign file (its sequence) or a bare Sequence document. One line per finding, <file>:<line>:<col> error|warning <code> <path>: <message>. <hint> -> <docs_url>; exit 2 on any error, 0 otherwise.
curviate campaign initWrite a Campaign file from a template (connect-and-converse, engage-then-connect, nurture-connections). Fill lead_list_ids and account_ids, then create it.
curviate campaign voice-clip uploadUpload one audio file (MP3, WAV, M4A, WebM or Ogg) and print the clip: its id (vc_...) is the clip_id of a voice.send step. 1 to 120 seconds, up to 20 MiB, 100 uploads per Team per 24 hours. The file is converted once and the original is discarded. Nothing reaches LinkedIn. Needs Automate.
curviate campaign voice-clip getOne Voice clip: duration, size, file name and upload time. No download link. Another Team's clip is RESOURCE_NOT_FOUND, like an unknown id.

Exit codes: the exit code table.