RXrxfoodapp
careteam

Submit a care team challenge points event

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

Request

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

Path parameters

patient_idinteger required

Request body

challenge_id'thirty-plant-challenge'

Required for plant events. Must be thirty-plant-challenge.

challenge_run_idstring

Required for plant events.

event_type'QUIZ_COMPLETED' | 'TASK_COMPLETED' | 'TASK_UNCHECKED' | 'PLANT_LOGGED' | 'PLANT_UNLOGGED' required
idempotency_keystring required

For plant events, must be canonical: thirty-plant-challenge:{challenge_run_id}:plant:{plant_source}:{url_encoded_plant_key}:{logged|unlogged}:{client_event_id}.

plant_keystring

Required for plant events. Canonicalized by mobile.

plant_source'manual' | 'meal_auto'

Required for plant events.

points_datestring date

Optional for plant events. Defaults to patient local date.

Response

successful operation

acceptedboolean required
delta_pointsinteger required
outcome'applied' | 'reversed' | 'no_op_duplicate' | 'no_op_cap_reached' | 'no_op_no_reversible_award' required
retiredboolean

Additive marker that legacy points are retired for this patient.

total_pointsinteger required

Changes