Skip to main content
reachboost leads has 13 commands. Each one lists its arguments, its flags and what it is allowed to change. Every command also accepts the global flags.

leads events

Get lead events. Read-only. Returns a paginated list of leads enriched with their campaign events.
Usage
Flags
number
The page number.
number
The number of results per page.
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.
uuid
Filter by sender UUID.
uuid
Filter by campaign UUID.
date
Start of the date range (YYYY-MM-DD).
date
End of the date range (YYYY-MM-DD).
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.
Example

leads get

Get lead by UUID. Read-only. Returns a lead by its UUID.
Usage
Arguments
uuid
required
The unique identifier for the lead.
Example

leads list

Get leads. Read-only. Returns all leads in your workspace. Supports filtering by field values.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Exact match filter (case-insensitive).
string
Exact match filter (case-insensitive).
string
Exact match filter (case-insensitive).
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.
Examples

leads list-blacklisted

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.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Exact match filter (case-insensitive).
string
Exact match filter (case-insensitive).
string
Exact match filter (case-insensitive).
enum
default or extended. One of: default, extended.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.

leads add-custom-fields

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

leads add-tags

Add tags to lead. Changes data. Adds tags to a lead by its UUID.
Usage
Arguments
uuid
required
The unique identifier for the lead.
Flags
uuid[]
Repeat the flag for several values.
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

leads blacklist

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.
Usage
Flags
string[]
Repeat the flag for several values.
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.

leads bulk

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

leads enrich

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.
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Flags
uuid
An existing lead in the workspace.
string
A LinkedIn profile URL. Normalised the same way as on lead creation; a URL that matches no lead creates one.
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.
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.

leads remove-custom-fields

Remove custom fields from lead. Destructive: needs —yes. Removes custom fields from a lead by its UUID.
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 lead.
Flags
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.

leads remove-tags

Remove tags from lead. Destructive: needs —yes. Removes tags from a lead by its UUID.
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 lead.
Flags
uuid[]
Repeat the flag for several values.
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.

leads unblacklist

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.
Usage
Flags
string[]
Repeat the flag for several values.
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.

leads update

Update lead. Changes data. Updates a lead by its UUID.
Usage
Arguments
uuid
required
The unique identifier for the lead.
Flags
string
string
string
string
string
string
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.