notify

Recall a send

Changed on Oct 28, 2026

Close the reveal on a sealed send: revoke the access grants, or destroy the sealed content outright. Idempotent, and partial by design — one recipient failing never stops the rest, and every failure is reported. A plaintext send has no grant to revoke and is refused.

post/products/notify/sends/{sendId}/recall

Request

Base URL
https://api.sparkvault.com/v1
Auth
- API key in header X-API-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/products/notify/sends/:sendId/recall/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sendIdstring required

The send to recall.

Request body

recipient_idsstring[]

Recall only these recipients, each read as a recipient key (trimmed, with an email address lowercased the way Identity stores it; see NotifyRecipient). Ids not on the send come back in not_found, in that form, rather than failing the call.

mode'grant' | 'content'

grant revokes the access grants, leaving the content intact for any other share. content destroys the sealed content itself, which only a send that sealed its content has: a content recall of an ingot send (a file from the owner's vault) is a 400, refused before anything is revoked or stopped.

Response

The recall ran; the body reports what it reached.

Changes

Oct 28, 2026a9a10e328ba5 Revision changes
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 28, 202656d7c265a77a Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history