Share a deck publicly
share_deckPublish a signed-in user's Anki deck to AnkiWeb's public catalogue after a limits-checked preview and explicit confirmation.
Instructions
Publish one of the signed-in user's decks to AnkiWeb's public shared-deck catalogue, under their account. Anyone can then find and download it.
Without confirm, nothing is published: the call checks the deck and the listing against AnkiWeb's limits and returns a preview. Show that preview to the user and get their explicit go-ahead before calling again with confirm: true.
Calling with confirm: true publishes the deck and makes AnkiWeb's declaration on the user's behalf: "I declare that the material I am sharing is entirely my own work, or I have obtained a license from the intellectual property holder(s) to share it here."
A deck that is already shared is refused. Needs an AnkiWeb session.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deck | Yes | The deck's id or its exact full name, as list_my_decks gives them. | |
| tags | No | Up to 60 characters in all, joined by spaces. | |
| title | No | The listing's title, up to 60 characters. Required unless AnkiWeb has one from an earlier share. | |
| confirm | No | true publishes. Only after the user has seen the preview and agreed. | |
| supportUrl | No | A page where users can ask about the deck, up to 180 characters. | |
| description | No | Markdown, up to 65000 characters. Required unless AnkiWeb has one from an earlier share. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| deck | Yes | ||
| tags | Yes | ||
| title | Yes | ||
| status | Yes | `pending` means AnkiWeb accepted the share and is still processing it. | |
| problems | Yes | Each one blocks publishing until it is fixed. | |
| sharedId | No | ||
| supportUrl | Yes | ||
| description | Yes | ||
| sharesPerWeek | Yes | ||
| sharesInLast7Days | Yes |