Set a deck's newCardsPerDay to the recommended value

Write. Computes the same plan as previewDeadlinePlan, then PATCHes that owned deck's newCardsPerDay to the recommended integer. Reuses updateDeck. deckId is required. Another token's deck is 404. Discuss the number with the person first. Do not apply in silence just to hit a date if they cannot study that many cards. Create still requires an explicit N.

post/plan/new-cards/apply

Request

  • Base URL: https://fluidrecall.com/api/v1
  • URL: https://fluidrecall.com/api/v1/plan/new-cards/apply
  • Auth: one of:
    • HTTP bearer
    • HTTP dpop

Request body

deadlinestring required

YYYY-MM-DD preferred. A UTC instant ending in Z is converted to the study day in timezone.

asOfstring

UTC ISO-8601 timestamp ending in Z

timezonestring

IANA name. Defaults to the account timezone.

dayBoundaryHourinteger
remainingNewCardsinteger
totalCardsinteger
alreadyLearnedinteger
skipWeekendsboolean
studyDaysPerWeekinteger
bufferStudyDaysinteger

Reserve this many study days at the end of the window as review-only buffer.

currentNewCardsPerDayinteger nullable

Compare this N to the recommendation. Omit to use the deck's effective N when deckId is set.

deckIdstring uuid required

Fill remaining new cards and current N from this owned deck unless you override them.

Response

The plan and the patched deck.

deadlinestring required

Deadline study day as YYYY-MM-DD.

asOfstring required

UTC ISO-8601 timestamp ending in Z

asOfStudyDaystring required

Study day of asOf as YYYY-MM-DD.

timezonestring required
dayBoundaryHourinteger required
remainingNewCardsinteger required
alreadyLearnedinteger required
totalCardsinteger required
calendarDaysUntilDeadlineinteger required
studyDaysUntilDeadlineinteger required
recommendedNewCardsPerDayinteger required

ceil(remainingNewCards / studyDaysUntilDeadline), clamped to 0–9999. Not a default of 20. A floor from the deadline.

currentNewCardsPerDayinteger nullable required
projectedFinishDateAtCurrentstring nullable required

YYYY-MM-DD of the last new-card introduction at the current N. Null if current N is missing or 0.

projectedFinishDateAtRecommendedstring nullable required
onTrackboolean nullable required

True when current N finishes remaining new cards by the deadline. Null when there is no current N.

pace'done' | 'overdue' | 'faster' | 'on_track' | 'slower' | 'unknown' required
countsFromDeckboolean required
appliedboolean required
deckIdstring uuid nullable required
deckobject nullable required

The patched deck after apply. Null on preview.

assumptionsstring[] required
coachingstring required

Changes

No recorded changes to this operation across all 1 revision of this API.