Revoke a delivery

POST/v1/deliveries/{id}/revoke

Blocked after confirmed (409 delivery_already_confirmed). The sender remedy post-confirmation is download-access expiry, not retraction.

Path parameters

idstringrequired

The delivery's ID, starting dlv_.

Returns

200 application/json. Revoked. See the Delivery object.

Errors have one shape; see Errors for every code.

Code language

Request

curl -X POST "https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke" \
  -H "Authorization: Bearer $PARASEND_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const res = await fetch('https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PARASEND_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await res.json();

import os, requests, uuid

res = requests.post(
    "https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke",
    headers={
        "Authorization": f"Bearer {os.environ['PARASEND_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
data = res.json()

using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PARASEND_KEY"));
request.Headers.Add("Idempotency-Key", Guid.NewGuid().ToString());
var response = await http.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

var request = HttpRequest.newBuilder(URI.create("https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke"))
    .header("Authorization", "Bearer " + System.getenv("PARASEND_KEY"))
    .header("Idempotency-Key", UUID.randomUUID().toString())
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.parasend.com/v1/deliveries/dlv_01M6R27T05512SCV3852TPM2XY/revoke', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'),
        'Idempotency-Key' => bin2hex(random_bytes(16)),
    ],
]);
$data = json_decode($response->getBody(), true);

Response · 200

{
  "id": "dlv_01M6R27T05512SCV3852TPM2XY",
  "object": "delivery",
  "kind": "documents",
  "direction": "outbound",
  "content_type": "files",
  "status": "revoked",
  "last_activity": {
    "at": "2026-11-06T09:15:05.969Z",
    "type": "revoked"
  },
  "title": "Final notice: invoice 2026-114",
  "message": null,
  "language": "en",
  "certificate_language": "is",
  "recipient": {
    "name": "Anna Björk Jónsdóttir",
    "verified_name": null,
    "verified_method": null,
    "verification_photos": [],
    "email": "anna.bjork@example.com",
    "phone": null,
    "address": {
      "city": "Kópavogur",
      "line1": "Akralind 3",
      "line2": null,
      "source": "manual",
      "country": "IS",
      "postal_code": "201"
    },
    "verification_level": "high",
    "conditional_authentication": false,
    "personal_code": null,
    "id_document_number": null
  },
  "files": [
    {
      "file_id": "fil_01M6R27SZK99V6N6WG4GK15T6R",
      "path": "test-notice.pdf",
      "primary": true
    }
  ],
  "batch_id": null,
  "delivery_url": null,
  "short_url": null,
  "evidence_policy": "urn:parasend:policy:evidence:standard:1",
  "sender_display": "legal_person",
  "operator_reference": "OP-7K3Q-M2",
  "recipient_ref": "rcp_01M6R27T05ZNSRNMAW2CA8MTF6",
  "private": false,
  "options": {
    "auth_methods": [
      "audkenni",
      "smart_id",
      "passkey"
    ],
    "reminder_policy": null,
    "brand_profile_id": null,
    "expires_in_days": 30,
    "sender_display": "legal_person",
    "notify_channels": [
      "email"
    ]
  },
  "legal_hold": false,
  "deletion_scheduled_at": null,
  "livemode": false,
  "created": "2026-11-06T09:15:05.604Z",
  "expires_at": "2026-12-06T09:15:05.603Z",
  "metadata": {
    "case_ref": "IN-2026-114"
  },
  "origin_request": null,
  "reminder_waiting": null,
  "email_waiting": null,
  "follow_up": {
    "policy_id": null,
    "policy_name": null,
    "policy_source": "none",
    "state": "done",
    "reminders_sent": 0,
    "last_step": null,
    "next_step": null,
    "paused": false
  }
}