Update Program

patch/v0/programs/{program_id}

Request

  • Base URL: https://api.adapted.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.adapted.app/v0/programs/{program_id}
  • Auth: none declared

Path parameters

program_idstring uuid required

Headers

authorizationstring

Request body

namestring nullable
status'active' | 'completed' | 'cancelled' nullable
duration_in_weeksinteger nullable
num_sessions_per_weekinteger nullable
session_duration_mininteger nullable
descriptionstring nullable
start_datestring date nullable
scheduled_daysinteger[] nullable
regionsBodyRegion[] nullable
metadataobject nullable
updated_atstring date-time

Response

Successful Response

idstring uuid required
namestring required
duration_in_weeksinteger required
num_sessions_per_weekinteger required
session_duration_mininteger required
descriptionstring nullable
start_datestring date nullable required
scheduled_daysinteger[] required
regionsBodyRegion[]
metadataobject nullable required
status'active' | 'completed' | 'cancelled'
next_session_status'generating' | 'failed' nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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