RXrxfoodapp
careteam

Redeem care team challenge points

Changed on
post/patients/{patient_id}/care-team-challenges/points/redeem

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/care-team-challenges/points/redeem
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required

Request body

idempotency_keystring required
reward_type'dietitian_session' | 'microbiome_test' | 'vitamins_supplements'

Canonical reward type.

Response

successful operation

acceptedboolean required
delta_pointsinteger required
outcome'applied' | 'insufficient_points' required
redemption_idinteger nullable
retiredboolean

Additive marker that legacy points are retired for this patient.

reward_codestring nullable
reward_type'dietitian_session' | 'microbiome_test' | 'vitamins_supplements' required

Canonical reward type.

total_pointsinteger required

Changes