# Share a pool snapshot

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

Share a pool snapshot so recipients can copy it into their own capacity. Heaven emails each recipient an invitation.

`POST /v1/pool/snapshot/modify`

## Parameters

- `pool` (string, required): Pool name or ID.
- `snapshot` (string, required): Snapshot name or ID.
- `users` (string[], required): Email address or user ID of a recipient who may copy the snapshot into their own account.
- `message` (string): Invitation email message, up to 500 bytes.
- `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 pool snapshot sharing change.
  - `expires_at` (string (date-time)): Expiry after which recipients can no longer copy the snapshot. Absent for no expiry. May be omitted.
  - `pool_snapshot` (object, always present): Snapshot whose sharing changed.
    - `id` (string, always present): Pool snapshot's ID.
    - `name` (string, always present): Pool snapshot's name.
    - `pool` (object, always present): Pool's ID and name.
      - `id` (string, always present): Referenced object's stable ID.
      - `name` (string, always present): Referenced object's name.
  - `users` (object[] | null, always present): Each recipient's sharing result and notification state.
    - `items` (object): A recipient's snapshot sharing result.
      - `email` (string): Recipient's email, when available. May be omitted.
      - `notice` (string): Sharing email status, including suppression after a recent notification. May be omitted.
      - `state` (string, always present): Whether the snapshot was shared, already shared or removed for this person.
      - `user_id` (string, always present): Recipient's user ID.

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

## Examples

```sh tab="heaven CLI"
heaven pool snapshot share add POOL SNAPSHOT --user USER ...
  [--message MESSAGE]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev pool snapshot share add POOL SNAPSHOT --user USER ...
  [--message MESSAGE]
  [--organization ORGANIZATION]
```

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

```json tab="MCP"
{ "tool": "pool_snapshot_share_add",
  "arguments": { "pool": "web", "snapshot": "before-upgrade", "users": ["ada@example.com"] } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "expires_at": "2026-11-23T12:00:00Z",
    "pool_snapshot": {
      "id": "f3ae26c2-a30e-4a28-a8ed-5aef74fd7de5",
      "name": "before-upgrade",
      "pool": {
        "id": "pool-157f59423c66b72c",
        "name": "web"
      }
    },
    "users": [
      {
        "email": "ada@example.com",
        "notice": "queued",
        "state": "shared",
        "user_id": "2b5cb812-ee3d-4e4b-ab68-70db5f80167b"
      }
    ]
  }
}
```
