Skip to main content
One command per documented API operation, generated from the API reference, plus four built into the CLI: auth set-key, auth remove, whoami and workspaces use. An operation that is not documented cannot become a command.
Command descriptions come from the CLI and the API reference, and are in English. This reference describes reachboost 0.2.0. Open the API reference.

Global flags

Accepted by every command, before or after the command name.
URL
API base URL. Default https://app.reachboost.io, or REACHBOOST_API_URL. Only point it at a server you trust: the API key is sent there.
uuid
Workspace to act on. Or REACHBOOST_WORKSPACE, or the profile’s stored default.
string
default:"default"
Which stored key and default workspace to use. Or REACHBOOST_PROFILE. Default “default”.
number
default:"30"
Give up on a request after this many seconds, 1 to 3600. Default 30.
boolean
Print the API response as JSON on stdout and nothing else.
boolean
Print list results as CSV on stdout (RFC 4180), for spreadsheets and pipelines.
string
Comma-separated fields to show in a table or CSV, instead of the defaults.
boolean
No status lines on stderr.

Commands

What the labels mean:

Authentication

reachboost auth · 2 commandsStoring, checking and forgetting the API key on this machine. The key itself is created and revoked in ReachBoost.

whoami

reachboost whoami · 1 commandShow which key and workspace commands will use, and check that they work.

Workspaces

reachboost workspaces · 8 commandsThe workspaces an agency key may act on, and which one this profile uses by default.

Campaigns

reachboost campaigns · 20 commandsOutreach sequences and their messages. A campaign is created as a draft and can be edited, given messages and leads while it stays one; for those edits the CLI reads the status just before sending and refuses a campaign that has started (a check, not a transaction: a campaign started in that instant would still be edited). A flow campaign’s steps are replaced with replace-flow, which still accepts changes to step content once the campaign has run. publish starts a draft. Pausing, finishing and stopping leads are not in this release.

Inbox

reachboost inbox · 5 commandsConversations and messages from the connected LinkedIn accounts. Read-only: sending is done in the app, by a person.

Integrations

reachboost integrations · 1 commandList integrations a flow can push to.

Invitations

reachboost invitations · 4 commandsInvitations to join the workspace. Creating one sends the invitation mail and prints the link; withdrawing one stops the link working.

Lead lists

reachboost lead-lists · 9 commandsNamed sets of leads, imported or scraped, that campaigns draw from.

Leads

reachboost leads · 13 commandsThe people in your workspace, whichever list or campaign they belong to, with their tags, custom fields and activity.

Senders

reachboost senders · 4 commandsThe LinkedIn accounts that send outreach. Deleting one cannot be undone.

stats

reachboost stats · 1 commandGet statistics. Read-only. Returns aggregated campaign statistics for a date range.

Tags

reachboost tags · 5 commandsLabels you attach to leads to group and filter them.

Members

reachboost users · 4 commandsThe people who have access to the workspace. Only first and last names can be changed, not email addresses; admins cannot be removed from the command line.

Webhooks

reachboost webhooks · 5 commandsWhere ReachBoost posts events such as an accepted connection or a reply: list, create, change and remove a workspace’s webhooks.