Rename a deck or set its new-card allowance
Write. Rename this deck, change its description, set or clear deckNote, set newCardsPerDay, or any combination. Send at least one of name, description, deckNote, and newCardsPerDay. An empty body is 400. name, when present, is non-empty after trim and at most 120 characters. A blank name is 400. description, when present, is a non-empty string of at most 2000 characters, or null to clear it. Omit description to leave it unchanged. deckNote, when present, is a non-empty string of at most 4000 characters, or null to clear it. Coaching notes are instructions for how an agent should quiz and coach. They are not the answer, not graded content, and not the quiz prompt. A deck note applies to every card in that deck. A card note is optional and additive with the deck note. Retrieve responses (listDue, upcoming-new, inventory, getCard, reveal, and agent session start/next/grade) include deckNote and cardNote so one call carries coaching context. Scripture / dictation: The learner needs every word remembered correctly, but often answers via dictation where punctuation gets messy. They set a deck note instructing the agent to check every word exactly, but not fail on punctuation differences, and to include that reason when coaching. This is only an example — notes can be any coaching preference for how agents should quiz/coach for that deck (or a specific card). newCardsPerDay is optional when name, description, or deckNote is present. Send the integer this deck should use now. Revisit the integer when their study time changes, the deadline moves, or the cards are denser or lighter than you expected. Choose newCardsPerDay with the person for this deck. There is no default of 20. When they have a deadline, call previewDeadlinePlan first: it returns ceil(remaining new cards / study days) as a floor. Weigh study time (more time, a higher number), that deadline floor, and card complexity (tiny facts such as times tables can be higher; a beefy card such as the five steps of a cycle must be lower). You may raise N above the floor or negotiate more study time. Send that integer. After bulk card adds, re-run previewDeadlinePlan with that deckId and consider applyDeadlinePlan or updateDeck. 0 introduces no new cards unless the caller asks for extras. Null returns the deck to the account fallback. Do not send null to skip the decision, and do not assume 20. Renaming, changing the description, or setting a note does not move dueAt and does not change scheduling state. Another token's deck is 404.
Request
- Base URL: https://fluidrecall.com/api/v1
- URL: https://fluidrecall.com/api/v1/decks/{deckId}
- Auth: one of:
- HTTP bearer
- HTTP dpop
Path parameters
Request body
Response
The deck, including effectiveNewCardsPerDay.
Changes
No recorded changes to this operation across all 1 revision of this API.