Skip to main content
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
Arguments
uuid
required
The unique identifier for the campaign.

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
Arguments
uuid
required
The unique identifier for the campaign.

campaigns get-message

Get campaign message. Read-only.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
uuid
required
The unique identifier for the campaign message.

campaigns leads

List leads in a campaign. Read-only.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
number
The page number.
number
The number of results per page.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.

campaigns list

List campaigns. Read-only.
Usage
Flags
number
The page number.
number
The number of results per page.
enum
Filter by campaign status. One of: active, inactive, draft, finished.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.
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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
number
Filter by exact message index (positive integer).
enum
Filter by message type. One of: connection_request, follow_up.

campaigns add-lead

Add a lead to a campaign. Changes data. Draft campaigns only. Creates the lead if it doesn’t exist (matched by linkedin_profile_url), then adds it to the campaign.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
string
Must be a valid https://www.linkedin.com/in/ URL. Various formats are auto-normalized.
string
string
string
string
string
enum
LinkedIn connection degree. One of: 1, 2, 3.
string
Email must be a valid email address and unique within the workspace.
string
Digits with an optional leading ”+” and common separators (spaces, dashes, dots, parentheses); must contain 6–15 digits.
string
string
number
Must be a non-negative integer.
string
string
string
ISO 3166-1 alpha-2 country code, stored upper-cased. Any other value is rejected.
JSON
As JSON, matching the documented shape.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
JSON
The leads to add. Each item has the same shape and rules as CreateLeadRequest. As JSON, matching the documented shape.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

campaigns create

Create a campaign. Changes data.
Usage
Flags
string
string
enum
One of: new_connections, existing_connections.
boolean
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.
uuid[]
UUIDs of senders to assign to this campaign. Repeat the flag for several values.
uuid[]
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.
JSON
As JSON, matching the documented shape.
JSON
As JSON, matching the documented shape.
JSON
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.
JSON
As JSON, matching the documented shape.
boolean
Automatically finish the campaign when all leads have been contacted.
JSON
As JSON, matching the documented shape.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.
Example

campaigns create-message

Create campaign message. Changes data. Draft campaigns only. Creates a new campaign message.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
number
default:"1"
Wait in days before sending the message. Defaults to 1.
enum
One of: connection_request, follow_up.
string
Message body. Required for follow_up. Optional for connection_request (empty requests are supported).
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

campaigns delete-message

Delete campaign message. Destructive: needs —yes. Draft campaigns only. Deletes a campaign message and returns the updated campaign message list.
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
uuid
required
The unique identifier for the campaign message.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
boolean
Accepted for consistency; this command is not in this release.
boolean
Accepted for consistency; this command is not in this release.
string
Accepted for consistency; this command is not in this release.

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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
boolean
Accepted for consistency; this command is not in this release.
boolean
Accepted for consistency; this command is not in this release.
string
Accepted for consistency; this command is not in this release.

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 in field 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).
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

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 of nodes is deleted, unless leads have already reached it (step_in_use).
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
JSON
As JSON, matching the documented shape.
JSON
As JSON, matching the documented shape.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
boolean
Accepted for consistency; this command never sends anything.
boolean
Accepted for consistency; this command never sends anything.

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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
boolean
Accepted for consistency; this command is not in this release.
boolean
Accepted for consistency; this command is not in this release.
string
Accepted for consistency; this command is not in this release.

campaigns update

Update a campaign. Changes data. Draft campaigns only.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
Flags
string
string
uuid[]
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.
uuid[]
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.
JSON
As JSON, matching the documented shape.
JSON
As JSON, matching the documented shape.
JSON
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.
JSON
As JSON, matching the documented shape.
boolean
JSON
As JSON, matching the documented shape.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

campaigns update-message

Update campaign message. Changes data. Draft campaigns only. Updates a campaign message.
Usage
Arguments
uuid
required
The unique identifier for the campaign.
uuid
required
The unique identifier for the campaign message.
Flags
number
Wait in days before sending the message.
string
Updated message body.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

campaigns voice-notes

Upload a voice note. Changes data. Uploads the audio for a voice_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
Arguments
uuid
required
The unique identifier for the campaign.
Flags
string
The audio file, base64 encoded. At most 12 MB once decoded.
string
The file name, such as intro.m4a.
number
Where the part to keep starts, in milliseconds.
number
Where the part to keep ends, in milliseconds.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.