reachboost campaigns has 20 commands. Each one lists its arguments, its flags and what it is allowed to change.
Every command also accepts the global flags.
campaigns get
Get a campaign. Read-only.Usage
campaigns get-flow
Get a flow campaign’s steps. Read-only. The steps of a flow campaign and how they connect. Start settings (senders, lead lists, limits, hours and days) are not part of the flow: read and change them on the campaign itself. A classic campaign has no flow and answers 404.Usage
campaigns get-message
Get campaign message. Read-only.Usage
campaigns leads
List leads in a campaign. Read-only.Usage
campaigns list
List campaigns. Read-only.Usage
Examples
campaigns list-messages
List campaign messages. Read-only. Returns the ordered sequence of readable campaign messages (connection_request, follow_up) for a campaign.
Usage
campaigns add-lead
Add a lead to a campaign. Changes data. Draft campaigns only. Creates the lead if it doesn’t exist (matched bylinkedin_profile_url), then adds it to the campaign.
Usage
Digits with an optional leading ”+” and common separators (spaces, dashes, dots, parentheses); must contain 6–15 digits.
campaigns bulk-add
Add leads to a campaign in bulk. Changes data. Draft campaigns only. Accepts up to 100 leads in one request and processes them in the background. All or nothing: if any lead fails validation, the whole batch is refused and nothing is queued.Usage
The leads to add. Each item has the same shape and rules as
CreateLeadRequest. As JSON, matching the documented shape.campaigns create
Create a campaign. Changes data.Usage
true creates a flow campaign, with branching steps set through the campaign flow endpoint. Only available when the flow builder is enabled for the workspace (otherwise 422), and fixed once the campaign exists.
UUIDs of lead lists to use as the source of leads. Send an empty array to insert leads via the API instead of using lead lists. Repeat the flag for several values.
Time window during which the campaign is active, as HH:MM in UTC at today’s offset. The campaign keeps the matching local time in the workspace timezone, so the same window reads one hour different in UTC after a daylight saving change. As JSON, matching the documented shape.
Example
campaigns create-message
Create campaign message. Changes data. Draft campaigns only. Creates a new campaign message.Usage
Message body. Required for
follow_up. Optional for connection_request (empty requests are supported).campaigns delete-message
Delete campaign message. Destructive: needs —yes. Draft campaigns only. Deletes a campaign message and returns the updated campaign message list.Usage
campaigns finish
Finish a campaign. Not in this release. It changes outreach that is already under way. The team decided to ship reads and draft edits first. Use the ReachBoost app.Not in this release. See What the CLI will not do.
Usage
campaigns pause
Pause a campaign. Not in this release. It changes outreach that is already under way. The team decided to ship reads and draft edits first. Use the ReachBoost app.Not in this release. See What the CLI will not do.
Usage
campaigns publish
Publish a draft campaign. Destructive: needs —yes. Starts a draft campaign, so its senders send its steps on LinkedIn for the first time. One action for classic and flow campaigns. The campaign needs a sender and a lead list or API leads. A classic campaign also needs what the app asks for before its Start campaign button appears: at least one message step, daily limits, active hours, at least one active day, and senders that are connected to LinkedIn. Each refusal names the campaign parameter that fixes it infield when applicable. Classic publishing enrolls eligible leads from the selected lists and refuses with no_valid_profiles when none are eligible. Campaigns receiving API leads may start empty and have automatic finishing disabled. A flow campaign also needs at least one step and a flow that passes the flow rules. Only a draft can be published: a running campaign answers already_published, and a paused or finished one answers not_draft (a paused campaign is resumed instead).
Usage
campaigns replace-flow
Replace a flow campaign’s steps. Destructive: needs —yes. Replaces the whole flow: every step and every edge. A step left out ofnodes is deleted, unless leads have already reached it (step_in_use).
Usage
campaigns resume
Resume a campaign. Not available through the CLI: Resuming a paused campaign restarts outreach from a LinkedIn account. That is done in the ReachBoost app, by a person, on purpose. A draft is started with campaigns publish.Not available through the CLI. See What the CLI will not do.
Usage
campaigns stop-leads
Stop specific leads in a campaign. Not in this release. It changes outreach that is already under way. The team decided to ship reads and draft edits first. Use the ReachBoost app.Not in this release. See What the CLI will not do.
Usage
campaigns update
Update a campaign. Changes data. Draft campaigns only.Usage
UUIDs of the senders the campaign sends as, replacing the current ones. Send an empty array to remove them all. Draft campaigns only; the request is refused if the campaign has already started. Repeat the flag for several values.
UUIDs of lead lists to use as the source of leads. Send an empty array to insert leads via the API instead of using lead lists. Draft campaigns only; the request is refused if the campaign has already started. Repeat the flag for several values.
Time window during which the campaign is active, as HH:MM in UTC at today’s offset. The campaign keeps the matching local time in the workspace timezone, so the same window reads one hour different in UTC after a daylight saving change. As JSON, matching the documented shape.
campaigns update-message
Update campaign message. Changes data. Draft campaigns only. Updates a campaign message.Usage
campaigns voice-notes
Upload a voice note. Changes data. Uploads the audio for avoice_note step of a flow campaign. Set the returned voice_note_id as the step’s settings.voice_note_id on Replace a flow campaign’s steps. Nothing is sent until the campaign is published.
Usage

