Objetivo

Realizar el agendamiento de una clase experimental para un prospect, creando o vinculándolo a una clase existente.

Endpoint

Create a new experimental class and enroll the member on it

POST /api/v1/activities/schedule-experimental-class

Requisitos

idProspect: Identificador del prospect que participará en la clase.

service: El prospect debe estar vinculado a un servicio configurado con la etiqueta aula experimental.

activity: Nombre de la actividad que será creada o utilizada para la clase.

activityExist: Define si la actividad ya existe (true o false).

activityDate: Fecha y hora de la clase experimental en el formato yyyy-MM-dd HH:mm.

Paso a Paso

1. Obtenga el ID del Prospect

Consulte el endpoint Get prospects.

Asegúrese de que el prospect exista en el sistema. En caso contrario, inserte un nuevo prospect utilizando el endpoint POST prospects.

Consejo: Siempre verifique si el prospect ya existe antes de crear uno nuevo.

2. Cree un Servicio con la Etiqueta Aula Experimental

Este material ayuda a crear un servicio de aula experimental

Cree un servicio con la etiqueta "aula experimental".

Asegúrese de que el servicio tenga precio cero, ya que se trata de una clase gratuita.

Ejemplo:

Nombre del servicio: Clase Experimental de Yoga

Etiqueta: aula experimental

3. Vincule el Servicio al Prospect

Para asociar el servicio al prospect, genere una venta sin valor.

4. Consulte o Cree la Actividad

Si la clase ya existe:

Utilice el parámetro activityExist como true y proporcione el nombre correcto de la actividad en el campo activity.

El sistema buscará la clase existente en el horario especificado.

Si la clase no existe:

Utilice el parámetro activityExist como false.

El sistema creará una nueva actividad en el horario especificado.

Importante:
Si activityExist es true y la clase no existe en el horario informado, el sistema no creará automáticamente una nueva clase. Asegúrese de validar los datos de la actividad.

5. Realice el Agendamiento

Agregue los siguientes parámetros en la solicitud:

Parámetro	Tipo	Obligatorio	Descripción
`idProspect`	int32	Sí	Identificador del prospect.
`activityDate`	date-time	Sí	Fecha y hora en el formato `yyyy-MM-dd HH:mm`.
`service`	string	Sí	Nombre del servicio configurado con la etiqueta "aula experimental".
`activity`	string	Sí	Nombre de la actividad (existente o nueva).
`activityExist`	boolean	No	Define si la actividad ya existe. Valor predeterminado: `false`.
`idBranch`	int32	No	Identificador de la sucursal donde se realizará la clase.

Ejemplo de Solicitud

Preguntas Frecuentes

1. ¿Cómo insertar al cliente en una clase ya existente?

Defina el parámetro activityExist como true y proporcione el nombre correcto de la actividad en el campo activity.

El sistema buscará la clase en el horario especificado y agregará al prospect.

2. ¿Es necesario buscar las clases existentes previamente?

Sí, si desea insertar al cliente en una clase que ya existe.

Confirme la existencia de la actividad para evitar errores. Si la clase no existe, defina activityExist como false para crear una nueva.

3. ¿Qué sucede si `activityExist` es `true` y la clase no existe?

El sistema no creará automáticamente una nueva clase.

En este caso, la solicitud puede fallar y será necesario revisar los datos.

4. ¿Cómo crear un servicio con la opción "Aula Experimental"?

En la configuración del servicio, agregue la etiqueta "aula experimental".

Utilice el mismo nombre del servicio en la solicitud de agendamiento.

5. ¿Cómo garantizar que el prospect existe?

Siempre consulte el endpoint Get prospects antes de crear uno nuevo.

Si no existe, utilice POST prospects para registrar uno nuevo y obtener el idProspect.

Resultado Esperado

Si todos los pasos se siguen correctamente, el prospect será agendado para la clase experimental deseada. Si la clase ya existe, será agregado a ella. De lo contrario, se creará una nueva clase.

Consejos Finales

Siempre valide si el servicio y la actividad existen antes de realizar el agendamiento.

Asegúrese de que el servicio tenga la etiqueta "aula experimental".

Utilice activityExist: false si desea crear una nueva actividad.

Soporte

Si tiene dudas o dificultades, contacte con nuestro soporte.

Agendamiento de una clase experimental

Objetivo#

Endpoint#

Requisitos#

Paso a Paso#

1. Obtenga el ID del Prospect#

2. Cree un Servicio con la Etiqueta Aula Experimental#

3. Vincule el Servicio al Prospect#

4. Consulte o Cree la Actividad#

5. Realice el Agendamiento#

Ejemplo de Solicitud#

Preguntas Frecuentes#

1. ¿Cómo insertar al cliente en una clase ya existente?#

2. ¿Es necesario buscar las clases existentes previamente?#

3. ¿Qué sucede si activityExist es true y la clase no existe?#

4. ¿Cómo crear un servicio con la opción "Aula Experimental"?#

5. ¿Cómo garantizar que el prospect existe?#

Resultado Esperado#

Consejos Finales#

Soporte#