Parameters
#poolstringRequired
Pool name or ID.
snapshotstringRequired
Snapshot name or ID.
usersstring[]Required
Email address or user ID of a recipient who may copy the snapshot into their own account.
messagestring
Invitation email message, up to 500 bytes.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
A pool snapshot sharing change.
Show 3 attributesHide attributes
expires_atstring (date-time)
Expiry after which recipients can no longer copy the snapshot. Absent for no expiry. May be omitted.
pool_snapshotobjectAlways present
Snapshot whose sharing changed.
Show 3 attributesHide attributes
idstringAlways present
Pool snapshot's ID.
namestringAlways present
Pool snapshot's name.
poolobjectAlways present
Pool's ID and name.
Show 2 attributesHide attributes
idstringAlways present
Referenced object's stable ID.
namestringAlways present
Referenced object's name.
usersobject[] | nullAlways present
Each recipient's sharing result and notification state.
Show 1 attributeHide attributes
itemsobject
A recipient's snapshot sharing result.
Show 4 attributesHide attributes
emailstring
Recipient's email, when available. May be omitted.
noticestring
Sharing email status, including suppression after a recent notification. May be omitted.
statestringAlways present
Whether the snapshot was shared, already shared or removed for this person.
user_idstringAlways present
Recipient's user ID.
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 loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.