Create or upsert a deck

POST/v1/decks

Creates a deck. If `external_id` is provided and already exists in the org, the existing deck is updated instead (200); otherwise a new deck is created (201).

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

Body parameters

titlestringoptionalmax 300 chars
statusstringoptional
share_modestringoptional
external_idstringoptionalmax 200 chars
metadataobjectoptional
Arbitrary key/value map; merge-on-write (§6).

Returns

200The upserted (already-existing) deck.
201The newly created deck.

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

Terminal

renza decks create \
  --title "Q3 Board Deck" \
  --status draft \
  --share-mode private \
  --external-id q3-board-deck

POST /v1/decks

curl https://api.renza.io/v1/decks \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q3 Board Deck",
  "status": "draft",
  "share_mode": "private",
  "external_id": "q3-board-deck"
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

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

const deck = await renza.decks.create({
  title: "Q3 Board Deck",
  status: "draft",
  share_mode: "private",
  external_id: "q3-board-deck",
});

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"
}