Quote a Financial aid appeal letter call (free)

Free pre-flight. Validates the input and returns the exact credit hold a real call would take at this account's price, without billing anything. An invalid input is still a 200: the body carries valid:false and the validation errors.

post/v1/tools/appeal/quote

Request

  • Base URL: https://api.counselorai.app
  • URL: https://api.counselorai.app/v1/tools/appeal/quote
  • Auth: HTTP bearer

Request body

studentNamestring

The student this is about. Used in the output text.

counselorNamestring

Who the letter is from. The counselor stays the author; this tool drafts, it does not sign.

schoolNamestring

The institution the appeal goes to.

appealType'changed_circumstances' | 'financial_hardship' | 'competing_offer' | 'special_circumstances' | 'error_correction'

What the appeal rests on. changed_circumstances is income loss or a new expense since the FAFSA, competing_offer is a match request, special_circumstances asks for a Professional Judgment review, error_correction fixes bad data on the original filing. financial_hardship is a legacy alias for changed_circumstances.

currentAwardstring

What the school offered, as written on the award letter.

amountNeededstring

The gap being asked for.

keyDetailsstring required

The circumstances, in the counselor or family's own words. This is what the letter is built out of, so specifics beat summaries.

competingstring

A competing offer to cite, if there is one.

statusstring[]

Student circumstances the letter should carry without labeling them. homeless and housing_insecure are the same category.

length'short' | 'standard' | 'detailed'

Roughly 330, 440 or 560 words.

naturalnessinteger

How plainly the letter should read. 1 is formal institutional, 5 is conversational.

Response

Quote

toolstring
validboolean
estimated_creditsinteger
estimated_usdnumber
max_credits_heldinteger
max_credits_supportedboolean
credit_balanceinteger
sufficientboolean
price_multipliernumber

Changes

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