# Share a pool

URL: https://heaven.dev/docs/reference/pools/share-add
Updated: 2026-11-21

Grant access to create Computers in a pool. Computers made by external recipients belong to the pool's account. For existing organization members, a share scopes access to the pool and can allow specific pool power commands. New recipients receive an email invitation.

`POST /v1/pool/modify`

## Parameters

- `pool` (string, required): Pool name or ID.
- `users` (string[]): Email address or user ID of the person to give pool access to.
- `with_organization` (string): Organization name to share the pool with.
- `team` (string): Recipient team: TEAM within your organization, ORGANIZATION@TEAM for another organization.
- `role` (string): Access for external recipients to Computers they create. Choose web for website access, root for SSH and website access, or admin to also manage the Computer. Defaults to root.
- `commands` (string[]): Additional command granted to a recipient. For external recipients, it applies to Computers they create. For members, the pool commands available to grant are pool start, pool stop, pool pause and pool resume.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): A saved pool share.
  - `commands` (string[] | null, always present): Additional commands granted by the resulting share.
  - `note` (string): Ownership and access consequences for Computers created through this share. May be omitted.
  - `notified` (integer, always present): Number of people notified by email.
  - `role` (string, always present): Resulting role, or `none` after removal.
  - `updated` (boolean, always present): Whether this request changed the share.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- CLI: `heaven login` with `HEAVEN_API_KEY` unset. MCP: Heaven sign-in. cURL: `HEAVEN_SIGN_IN_KEY` from approved device sign-in (`POST /v1/auth/create`).
- A key limited to a command list cannot run this command.
- **People:** Share the pool with the named people. Required: `users`. Optional: `role`, `commands`, `organization`.
- **Organization:** Share the pool with members of another organization. Required: `with_organization`. Optional: `role`, `commands`, `organization`.
- **Team:** Share the pool with a team. Required: `team`. Optional: `role`, `commands`, `organization`.

## Examples

```sh tab="heaven CLI"
heaven pool share add POOL
  [--user USER ...]
  [--with-organization WITH-ORGANIZATION]
  [--team TEAM]
  [--role ROLE]
  [--command COMMAND ...]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev pool share add POOL
  [--user USER ...]
  [--with-organization WITH-ORGANIZATION]
  [--team TEAM]
  [--role ROLE]
  [--command COMMAND ...]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/pool/modify \
  -H "Authorization: Bearer $HEAVEN_SIGN_IN_KEY" \
  --json '{"action": "share add", "pool": "web", "users": ["ada@example.com"], "role": "root"}'
```

```json tab="MCP"
{ "tool": "pool_share_add",
  "arguments": { "pool": "web", "users": ["ada@example.com"], "role": "root" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "commands": [],
    "note": "Computers created through this share belong to the organization acme, which pays for the pool: when the share ends, their creators lose access and the Computers stay with it.",
    "notified": 1,
    "role": "root",
    "updated": true
  }
}
```
