Challenges

Patch Challenge Progress

Update the current progress of a challenge. Automatically marks as completed if target is met for count-based challenges, or if the week ends under budget for spending challenges.

patch/api/challenges/{challenge_id}/progress

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/challenges/{challenge_id}/progress
  • Auth: HTTP bearer

Path parameters

challenge_idstring uuid required

Request body

current_amountnumber required

Response

Successful Response

idstring required
challenge_typestring required
titlestring required
descriptionstring required
briefing_reasonstring nullable
emojistring required
target_amountnumber required
current_amountnumber required
progress_pctnumber required
difficultystring required
statusstring required
streak_countinteger required
started_atstring required
expires_atstring required
completed_atstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.