Change Prescribed Workout

Description

Change the data of a prescribed workout for a customer, prospect, or staff member. Allows modification of information such as workout name, dates, observations, categories, restrictions, responsible instructor, duration, and weekly frequency.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Request Parameters (Query Params)

Parameter	Type	Required	Description
idWorkout	int32	Yes	ID of the workout to be changed.
workoutName	string	No	New name for the workout. If empty, keeps the current name.
startDate	string(date-time)	No	Start date of the workout.
expirationDate	string(date-time)	No	Expiration date of the workout.
observation	string	No	Observations about the workout.
categories	string	No	Categories of the workout, separated by commas. Replaces existing categories.
restrictions	string	No	Restrictions of the workout, separated by commas. Replaces existing restrictions.
idProfessor	int32	No	ID of the instructor responsible for creating the workout.
totalWeeks	int32	No	Total number of weeks the customer should perform the workout.
weeklyFrequency	int32	No	Planned weekly frequency for the customer to perform the workout.

📤 Response Structure

The response returns the updated data of the workout after the requested change.

Field	Type	Description
idTreino	int32	ID of the workout.
dtPrescricao	string(date-time)	Date of the workout prescription.
dtValidade	string(date-time)	Expiration date of the workout.
dataInicio	string(date-time)	Start date of the workout.
nome	string	Name of the workout.
professor	string	Name of the responsible instructor.
qtdSemanal	int32	Planned weekly quantity for the workout.
qtdSessoes	int32	Total number of workout sessions.
tipoTreino	int32	Type of workout (internal code).
idTreinoCategoria	int32	ID of the workout category.
obsTreino	string	Observations about the workout.
idCliente	int32	ID of the customer linked to the workout (0 if none).
idProspect	int32	ID of the prospect linked to the workout (0 if none).
idFuncionarioTreino	int32	ID of the staff member linked to the workout (0 if none).
flTreinoPadrao	boolean	Indicates if the workout is standard.
totalRegistros	int32	Total records related to the workout.
quantidadeSessoes	int32	Number of sessions calculated for the workout.
progressoFinalizado	int32	Amount of completed progress (sessions completed).
progressoPorcentagem	int32	Percentage of workout progress.
treinoAtivo	boolean	Indicates if the workout is active.
exportarImprimir	boolean	Indicates if the workout can be exported or printed.
totalSemanas	int32	Total number of weeks of the workout.
fotoProfessor	string	URL of the responsible instructor's photo (if available).
expandido	boolean	Indicates if the workout is expanded in the interface.
sessoesCalculada	int32	Number of calculated sessions.
professorAtual	string	Name of the current responsible instructor for the workout.
idProfessor	int32	ID of the instructor responsible for the workout.
idProfessorAtual	int32	ID of the current responsible instructor for the workout.
tags	string	Tags associated with the workout, separated by commas.
restricoes	string	Restrictions associated with the workout, separated by commas.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "idTreino": 0,
    "dtPrescricao": "2019-08-24T14:15:22.123Z",
    "dtValidade": "2019-08-24T14:15:22.123Z",
    "dataInicio": "2019-08-24T14:15:22.123Z",
    "nome": "string",
    "professor": "string",
    "qtdSemanal": 0,
    "qtdSessoes": 0,
    "tipoTreino": 0,
    "idTreinoCategoria": 0,
    "obsTreino": "string",
    "idCliente": 0,
    "idProspect": 0,
    "idFuncionarioTreino": 0,
    "flTreinoPadrao": true,
    "totalRegistros": 0,
    "quantidadeSessoes": 0,
    "progressoFinalizado": 0,
    "progressoPorcentagem": 0,
    "treinoAtivo": true,
    "exportarImprimir": true,
    "totalSemanas": 0,
    "fotoProfessor": "string",
    "expandido": true,
    "sessoesCalculada": 0,
    "professorAtual": "string",
    "idProfessor": 0,
    "idProfessorAtual": 0,
    "tags": "string",
    "restricoes": "string"
}

🟠400Bad Request

Change data from a client's prescribed workout

Change Prescribed Workout#

Description#

🔑 Request Parameters (Query Params)#