> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reachboost.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Campaigns

> Outreach 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.

`reachboost campaigns` has 20 commands. Each one lists its arguments, its flags and what it is allowed to change.

Read-only

Changes data

Needs --yes

Not in this release

Not available through the CLI

Every command also accepts the [global flags](https://docs.reachboost.io/cli/commands.md#global-flags).

## campaigns get

Read-only

Get a campaign. Read-only.

```bash Usage theme={null}
reachboost campaigns get "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

## campaigns get-flow

Read-only

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.

```bash Usage theme={null}
reachboost campaigns get-flow "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

## campaigns get-message

Read-only

Get campaign message. Read-only.

```bash Usage theme={null}
reachboost campaigns get-message "<campaign-uuid>" "<campaign-message-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**\<campaign-message-uuid>** `uuid` *required*

The unique identifier for the campaign message.

## campaigns leads

Read-only

List leads in a campaign. Read-only.

```bash Usage theme={null}
reachboost campaigns leads "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--page \<n>** `number`

The page number.

**--per-page \<n>** `number`

The number of results per page.

**--all** `boolean`

Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with --page.

## campaigns list

Read-only

List campaigns. Read-only.

```bash Usage theme={null}
reachboost campaigns list
```

**Flags**

**--page \<n>** `number`

The page number.

**--per-page \<n>** `number`

The number of results per page.

**--status \<value>** `enum`

Filter by campaign status. One of: `active`, `inactive`, `draft`, `finished`.

**--all** `boolean`

Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with --page.

```bash Examples theme={null}
reachboost campaigns list --status active
reachboost campaigns list --json
reachboost --profile staging campaigns list
reachboost campaigns list
```

## campaigns list-messages

Read-only

List campaign messages. Read-only. Returns the ordered sequence of readable campaign messages (`connection_request`, `follow_up`) for a campaign.

```bash Usage theme={null}
reachboost campaigns list-messages "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--index \<n>** `number`

Filter by exact message index (positive integer).

**--message-type \<value>** `enum`

Filter by message type. One of: `connection_request`, `follow_up`.

## campaigns add-lead

Changes data

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.

```bash Usage theme={null}
reachboost campaigns add-lead "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--linkedin-profile-url \<text>** `string`

Must be a valid `https://www.linkedin.com/in/` URL. Various formats are auto-normalized.

**--first-name \<text>** `string`

**--last-name \<text>** `string`

**--company-name \<text>** `string`

**--job-role \<text>** `string`

**--profile-headline \<text>** `string`

**--connection-degree \<value>** `enum`

LinkedIn connection degree. One of: `1`, `2`, `3`.

**--email \<text>** `string`

Email must be a valid email address and unique within the workspace.

**--phone-number \<text>** `string`

Digits with an optional leading "+" and common separators (spaces, dashes, dots, parentheses); must contain 6–15 digits.

**--company-domain \<text>** `string`

**--company-linkedin-url \<text>** `string`

**--company-headcount \<n>** `number`

Must be a non-negative integer.

**--company-industry \<text>** `string`

**--city \<text>** `string`

**--country-code \<text>** `string`

ISO 3166-1 alpha-2 country code, stored upper-cased. Any other value is rejected.

**--custom-fields \<json>** `JSON`

As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## campaigns bulk-add

Changes data

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.

```bash Usage theme={null}
reachboost campaigns bulk-add "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--leads \<json>** `JSON`

The leads to add. Each item has the same shape and rules as `CreateLeadRequest`. As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## campaigns create

Changes data

Create a campaign. Changes data.

```bash Usage theme={null}
reachboost campaigns create
```

**Flags**

**--name \<text>** `string`

**--description \<text>** `string`

**--campaign-type \<value>** `enum`

One of: `new_connections`, `existing_connections`.

**--flow-enabled \<true|false>** `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.

**--senders \<uuid>** `uuid[]`

UUIDs of senders to assign to this campaign. Repeat the flag for several values.

**--lead-list-uuids \<uuid>** `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.

**--connection-request-limit \<json>** `JSON`

As JSON, matching the documented shape.

**--follow-up-limit \<json>** `JSON`

As JSON, matching the documented shape.

**--active-hours \<json>** `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.

**--active-days \<json>** `JSON`

As JSON, matching the documented shape.

**--auto-finish \<true|false>** `boolean`

Automatically finish the campaign when all leads have been contacted.

**--exclude \<json>** `JSON`

As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

```bash Example theme={null}
reachboost campaigns create --body-file campaign.json
```

## campaigns create-message

Changes data

Create campaign message. Changes data. Draft campaigns only. Creates a new campaign message.

```bash Usage theme={null}
reachboost campaigns create-message "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--wait \<n>** `number` (default: 1)

Wait in days before sending the message. Defaults to `1`.

**--message-type \<value>** `enum`

One of: `connection_request`, `follow_up`.

**--message-content \<text>** `string`

Message body. Required for `follow_up`. Optional for `connection_request` (empty requests are supported).

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## campaigns delete-message

Needs --yes

Delete campaign message. Destructive: needs --yes. Draft campaigns only. Deletes a campaign message and returns the updated campaign message list.

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost campaigns delete-message "<campaign-uuid>" "<campaign-message-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**\<campaign-message-uuid>** `uuid` *required*

The unique identifier for the campaign message.

**Flags**

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## campaigns finish

Not in this release

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.

> [!NOTE]
>
> Not in this release. See [What the CLI will not do](https://docs.reachboost.io/cli/safety.md#what-the-cli-will-not-do).

```bash Usage theme={null}
reachboost campaigns finish "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--dry-run** `boolean`

Accepted for consistency; this command is not in this release.

**--yes** `boolean`

Accepted for consistency; this command is not in this release.

**--confirm-name \<name>** `string`

Accepted for consistency; this command is not in this release.

## campaigns pause

Not in this release

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.

> [!NOTE]
>
> Not in this release. See [What the CLI will not do](https://docs.reachboost.io/cli/safety.md#what-the-cli-will-not-do).

```bash Usage theme={null}
reachboost campaigns pause "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--dry-run** `boolean`

Accepted for consistency; this command is not in this release.

**--yes** `boolean`

Accepted for consistency; this command is not in this release.

**--confirm-name \<name>** `string`

Accepted for consistency; this command is not in this release.

## campaigns publish

Needs --yes

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).

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost campaigns publish "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## campaigns replace-flow

Needs --yes

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`).

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost campaigns replace-flow "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--nodes \<json>** `JSON`

As JSON, matching the documented shape.

**--edges \<json>** `JSON`

As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## campaigns resume

Not available through the CLI

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.

> [!NOTE]
>
> Not available through the CLI. See [What the CLI will not do](https://docs.reachboost.io/cli/safety.md#what-the-cli-will-not-do).

```bash Usage theme={null}
reachboost campaigns resume "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--dry-run** `boolean`

Accepted for consistency; this command never sends anything.

**--yes** `boolean`

Accepted for consistency; this command never sends anything.

## campaigns stop-leads

Not in this release

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.

> [!NOTE]
>
> Not in this release. See [What the CLI will not do](https://docs.reachboost.io/cli/safety.md#what-the-cli-will-not-do).

```bash Usage theme={null}
reachboost campaigns stop-leads "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--dry-run** `boolean`

Accepted for consistency; this command is not in this release.

**--yes** `boolean`

Accepted for consistency; this command is not in this release.

**--confirm-name \<name>** `string`

Accepted for consistency; this command is not in this release.

## campaigns update

Changes data

Update a campaign. Changes data. Draft campaigns only.

```bash Usage theme={null}
reachboost campaigns update "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--name \<text>** `string`

**--description \<text>** `string`

**--senders \<uuid>** `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.

**--lead-list-uuids \<uuid>** `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.

**--connection-request-limit \<json>** `JSON`

As JSON, matching the documented shape.

**--follow-up-limit \<json>** `JSON`

As JSON, matching the documented shape.

**--active-hours \<json>** `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.

**--active-days \<json>** `JSON`

As JSON, matching the documented shape.

**--auto-finish \<true|false>** `boolean`

**--exclude \<json>** `JSON`

As JSON, matching the documented shape.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## campaigns update-message

Changes data

Update campaign message. Changes data. Draft campaigns only. Updates a campaign message.

```bash Usage theme={null}
reachboost campaigns update-message "<campaign-uuid>" "<campaign-message-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**\<campaign-message-uuid>** `uuid` *required*

The unique identifier for the campaign message.

**Flags**

**--wait \<n>** `number`

Wait in days before sending the message.

**--message-content \<text>** `string`

Updated message body.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## campaigns voice-notes

Changes data

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.

```bash Usage theme={null}
reachboost campaigns voice-notes "<campaign-uuid>"
```

**Arguments**

**\<campaign-uuid>** `uuid` *required*

The unique identifier for the campaign.

**Flags**

**--audio-base64 \<text>** `string`

The audio file, base64 encoded. At most 12 MB once decoded.

**--filename \<text>** `string`

The file name, such as `intro.m4a`.

**--start-ms \<n>** `number`

Where the part to keep starts, in milliseconds.

**--end-ms \<n>** `number`

Where the part to keep ends, in milliseconds.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.