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

lead-lists get

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

lead-lists leads

Get leads in a lead list. Read-only. Returns all leads in a lead list by its UUID.
Usage
Arguments
uuid
required
The unique identifier for the lead list.
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.
Example

lead-lists list

Get lead lists. Read-only. Returns all lead lists in your workspace. Supports filtering by name, type, and status.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Partial match filter (case-insensitive).
enum
Filter by list type. One of: scrape, import, list.
enum
Filter by status. One of: draft, scraping, finished, failed.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.
Example

lead-lists add-lead

Add lead to lead list. Changes data. Creates the lead if it doesn’t exist (matched by linkedin_profile_url), then adds it to the lead list.
Usage
Arguments
uuid
required
The unique identifier for the lead list.
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.

lead-lists bulk-add

Add leads to a lead list in bulk. Changes data. 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 lead list.
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.
Example

lead-lists create

Create a lead list. Changes data.
Usage
Flags
string
string
enum
One of: scrape, import, list.
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.

lead-lists delete

Delete lead list. Destructive: needs —yes. Deletes a lead list 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 list.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

lead-lists remove-leads

Remove leads from lead list. Destructive: needs —yes. Pass an array of entries identifying leads to remove. Each entry must include either lead_uuid or linkedin_profile_url.
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 list.
Flags
uuid[]
One item per value; repeat the flag for several.
string[]
One item per value; repeat the flag for several.
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.

lead-lists update

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