Trash or permanently delete a deck

DELETE/v1/decks/{id}

Moves the deck to the trash (soft delete; restore with `PATCH { trashed: false }`). Pass `?permanent=true` to permanently delete an already-trashed deck and its stored content (irreversible).

Requires an API key (bearer), scoped to the active org. Supports idempotency keys.

Path parameters

idstringrequired

Query parameters

permanentstringoptional
Possible values: true, false

Returns

200The trashed deck, or a deletion confirmation when `?permanent=true`.

Failures use the standard error envelope with a closed set of codes.

Terminal

renza decks trash deck_2a9f8c1b

DELETE /v1/decks/{id}

curl https://api.renza.io/v1/decks/deck_2a9f8c1b \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X DELETE

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const deck = await renza.decks.trash("deck_2a9f8c1b");

Response 200

{
  "id": "deck_2a9f8c1b",
  "object": "deck",
  "title": "Q3 Board Deck",
  "status": "draft",
  "current_artifact": "art_7c1b…",
  "share_mode": "private",
  "external_id": "q3-board-deck",
  "folder": "fld_7a2c…",
  "livemode": true,
  "metadata": {},
  "trashed_at": null,
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}