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

# Leads

> The people in your workspace, whichever list or campaign they belong to, with their tags, custom fields and activity.

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

Read-only

Changes data

Needs --yes

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

## leads events

Read-only

Get lead events. Read-only. Returns a paginated list of leads enriched with their campaign events.

```bash Usage theme={null}
reachboost leads events
```

**Flags**

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

The page number.

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

The number of results per page.

**--event-types \<value>** `enum[]` *required*

Event types to filter by. Repeat the parameter or pass a comma-separated list. One of: `connection_request_sent`, `connection_request_accepted`, `connection_request_withdrawn`, `follow_up_sent`, `follow_up_replied`, `profile_visited`, `profile_followed`, `post_liked`. Repeat the flag for several values.

**--sender-uuid \<uuid>** `uuid`

Filter by sender UUID.

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

Filter by campaign UUID.

**--start-date \<date>** `date`

Start of the date range (YYYY-MM-DD).

**--end-date \<date>** `date`

End of the date range (YYYY-MM-DD).

**--all** `boolean`

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

```bash Example theme={null}
reachboost leads events --event-types follow_up_replied --start-date 2026-01-01
```

## leads get

Read-only

Get lead by UUID. Read-only. Returns a lead by its UUID.

```bash Usage theme={null}
reachboost leads get "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

```bash Example theme={null}
reachboost leads get "<uuid>"
```

## leads list

Read-only

Get leads. Read-only. Returns all leads in your workspace. Supports filtering by field values.

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

**Flags**

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

The page number.

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

The number of results per page.

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

Exact match filter (case-insensitive).

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

Exact match filter (case-insensitive).

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

Exact match filter (case-insensitive).

**--all** `boolean`

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

```bash Examples theme={null}
reachboost leads list --workspace "<other-workspace-uuid>"
reachboost leads list --all --columns first_name,last_name,company_name
```

## leads list-blacklisted

Read-only

Get blacklisted leads. Read-only. Returns the leads on the workspace blacklist, newest first, with the same filters, paging and views as `GET /leads`. This is how the outcome of a blacklist or unblacklist request is seen.

```bash Usage theme={null}
reachboost leads list-blacklisted
```

**Flags**

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

The page number.

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

The number of results per page.

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

Exact match filter (case-insensitive).

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

Exact match filter (case-insensitive).

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

Exact match filter (case-insensitive).

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

`default` or `extended`. One of: `default`, `extended`.

**--all** `boolean`

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

## leads add-custom-fields

Changes data

Add or update custom fields on lead. Changes data. Merges the provided custom fields into the lead. Existing fields with the same name are overwritten.

```bash Usage theme={null}
reachboost leads add-custom-fields "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

**Flags**

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

## leads add-tags

Changes data

Add tags to lead. Changes data. Adds tags to a lead by its UUID.

```bash Usage theme={null}
reachboost leads add-tags "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

**Flags**

**--tag-uuids \<uuid>** `uuid[]`

Repeat the flag for several values.

**--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 leads add-tags "<uuid>" --tag-uuids "<t1>" --tag-uuids "<t2>"
```

## leads blacklist

Changes data

Blacklist leads in bulk. Changes data. Puts up to 100 leads on the workspace blacklist. Nothing further is sent to a blacklisted lead, and the lead is skipped when added to a lead list or campaign. The same thing the Blacklist button in the app does.

```bash Usage theme={null}
reachboost leads blacklist
```

**Flags**

**--leads \<text>** `string[]`

Repeat the flag for several values.

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

## leads bulk

Changes data

Create or update leads in bulk. Changes data. Accepts up to 100 leads in one request and processes them in the background. The same batch as the lead list and campaign bulk endpoints, with no destination: each lead is created if it does not exist (matched by `linkedin_profile_url`) or updated if it does, and nothing else happens. No lead list and no campaign membership is written.

```bash Usage theme={null}
reachboost leads bulk
```

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

## leads enrich

Needs --yes

Enrich a lead. Destructive: needs --yes. Queues the enrichment of one lead: its LinkedIn profile data, email address, phone number, or any combination. Name the lead by `lead_uuid`, or by `linkedin_profile_url`; a URL that matches no lead in the workspace creates one first. Exactly one of the two must be given.

> [!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 leads enrich
```

**Flags**

**--lead-uuid \<uuid>** `uuid`

An existing lead in the workspace.

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

A LinkedIn profile URL. Normalised the same way as on lead creation; a URL that matches no lead creates one.

**--enrichment-options \<value>** `enum[]`

What to enrich. An unknown name refuses the request; a repeated one counts once. One of: `linkedin_profile`, `email`, `phone`. Repeat the flag for several values.

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

## leads remove-custom-fields

Needs --yes

Remove custom fields from lead. Destructive: needs --yes. Removes custom fields from a lead by its UUID.

> [!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 leads remove-custom-fields "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

**Flags**

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

**--yes** `boolean`

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

## leads remove-tags

Needs --yes

Remove tags from lead. Destructive: needs --yes. Removes tags from a lead by its UUID.

> [!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 leads remove-tags "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

**Flags**

**--tag-uuids \<uuid>** `uuid[]`

Repeat the flag for several values.

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

## leads unblacklist

Changes data

Remove leads from the blacklist in bulk. Changes data. Takes up to 100 leads off the workspace blacklist. Only the block is lifted: `blacklisted_at` is cleared and campaign enrolments closed by the earlier blacklisting stay as they are, exactly like the Unblacklist button in the app.

```bash Usage theme={null}
reachboost leads unblacklist
```

**Flags**

**--leads \<text>** `string[]`

Repeat the flag for several values.

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

## leads update

Changes data

Update lead. Changes data. Updates a lead by its UUID.

```bash Usage theme={null}
reachboost leads update "<uuid>"
```

**Arguments**

**\<uuid>** `uuid` *required*

The unique identifier for the lead.

**Flags**

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

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

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

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

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

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

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


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