Skip to main content
POST
Create a managed workspace

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

Body

application/json
name
string
required

Name of the workspace.

owner
string<uuid>
required

UUID of the agency user who will own the workspace. Must be a user of the agency, with the agency admin or agency member role.

billing_type
enum<string>
required
  • agency — the agency pays, and the workspace draws senders licenses from its pool.
  • stripe — the workspace pays for itself and takes no licenses.
Available options:
agency,
stripe
senders
integer

LinkedIn account licenses drawn from the agency's pool. Required when billing_type is agency; refused when it is stripe. Asking for more than the agency has free is refused with a message naming how many are left.

Required range: x >= 1

Response

The workspace that was created

uuid
string<uuid>

Unique identifier for the workspace.

name
string

Name of the workspace.

owner
string<uuid> | null

UUID of the agency user who owns this workspace. null for a workspace that has never had an owner set.

senders
integer

Number of sender licenses allocated to this workspace.

senders_in_use
integer

Number of senders in use in the workspace.

billing_type
enum<string>

How the workspace is billed.

  • agency — uses sender licenses from the agency.
  • stripe — billed independently outside the agency.
Available options:
agency,
stripe