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

workspaces get

Get the workspace. Read-only. Returns the workspace the request is made for: its name, the number of sender licences it has, how many senders are in use, and how it is billed. Any key that may act on the workspace can read it, so a workspace key learns the name of its own workspace and an agency key learns the name of the linked workspace it is acting on.
Usage

workspaces get-managed

Get a managed workspace. Read-only. Returns one workspace the agency manages.
Usage
Arguments
uuid
required
The unique identifier for the managed workspace.

workspaces list

List managed workspaces. Read-only. Returns a paginated list of all workspaces linked to the agency.
Usage
Flags
string
Filter by part of the workspace name, ignoring case.
enum
Filter by billing type. Exact match. One of: agency, stripe.
uuid
Filter by the UUID of the agency user who owns the workspace. Exact match.
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

workspaces create-managed

Create a managed workspace. Changes data. Creates a client workspace under the agency.
Usage
Flags
string
Name of the workspace.
uuid
UUID of the agency user who will own the workspace.
number
LinkedIn account licenses drawn from the agency’s pool.
enum
One of: agency, stripe.
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.

workspaces delete-managed

Delete a managed workspace. Irreversible: needs —yes and —confirm-name. Removes a managed workspace. This cannot be undone.
Cannot be undone. Needs --yes and --confirm-name. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the managed workspace.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.
string
The exact workspace name, repeated as a check that this is the right target. Cannot be undone.

workspaces disconnect-managed

Disconnect a managed workspace. Destructive: needs —yes. Unlinks a workspace from the agency. The workspace itself stays: its campaigns, leads and members are untouched, and its own people keep their access. What it loses is the agency’s access to it.
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 managed workspace.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

workspaces update-managed

Update a managed workspace. Changes data. Changes a managed workspace. Only the fields you send are changed. PUT is accepted as well and behaves identically.
Usage
Arguments
uuid
required
The unique identifier for the managed workspace.
Flags
string
uuid
number
enum
One of: agency, stripe.
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.

workspaces use

Remember a workspace as the profile’s default, so commands need no —workspace. The stored key must be allowed to use it.
Usage
Arguments
uuid
required
The workspace to act on by default.
Example