tools

Propose debt details

Use this when the user provides a debt's APR, minimum payment, or next due date to save. Propose saving debt details the user states in chat: APR, minimum payment, or next due date, e.g. 'my Chase card APR is 24.99%'. Pass debtId from betteroff_list_debts, else the debt name. Use only numbers the user stated. This changes nothing until the user approves it at the review link; never say it is done.

post/v1/tools/betteroff_propose_debt_details

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_propose_debt_details
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: debts:read, corrections:prepare)
    • HTTP bearer

Request body

debtIdstring uuid nullable

The debt's id from betteroff_list_debts. Preferred over debtName.

debtNamestring nullable

The debt's name as betteroff_list_debts returns it. Null when debtId is given.

interestRatenumber nullable required

APR as a percent, e.g. 24.99. Null to leave it unchanged.

minimumPaymentnumber nullable required

Minimum monthly payment. Null to leave it unchanged.

nextPaymentDueDatestring date nullable required

Next due date as YYYY-MM-DD. Null to leave it unchanged.

Response

Tool result

OR

Changes

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