Objective

Schedule an experimental class for a prospect, either creating a new one or linking to an existing class.

Endpoint

Create a new experimental class and enroll the member on it

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

Requirements

idProspect: Identifier of the prospect who will participate in the class.

service: The prospect must be linked to a service configured with the tag experimental class.

activity: Name of the activity that will be created or used for the class.

activityExist: Defines whether the activity already exists (true or false).

activityDate: Date and time of the experimental class in the format yyyy-MM-dd HH:mm.

Step by Step

1. Obtain the Prospect ID

Consult the endpoint Get prospects.

Ensure that the prospect exists in the system. If not, insert a new prospect using the POST prospects endpoint.

Tip: Always check if the prospect exists before inserting a new one.

2. Create a Service with the Experimental Class Tag

This material helps to create a service for experimental class

Create a service with the tag "experimental class".

Ensure that the service has a zero price, as it is a free class.

Example:

Service name: Yoga Experimental Class

Tag: experimental class

3. Link the Service to the Prospect

To associate the service with the prospect, generate a zero-value sale.

4. Consult or Create the Activity

If the class already exists:

Use the activityExist parameter as true and provide the correct name of the activity in the activity field.

The system will look for the existing class at the specified time.

If the class does not exist:

Use the activityExist parameter as false.

The system will create a new activity at the specified time.

Important:
If activityExist is true and the class does not exist at the specified time, the system will not automatically create a new class. Make sure to validate the activity data.

5. Schedule the Class

Add the following parameters to the request:

Parameter	Type	Required	Description
`idProspect`	int32	Yes	Identifier of the prospect.
`activityDate`	date-time	Yes	Date and time in the format `yyyy-MM-dd HH:mm`.
`service`	string	Yes	Name of the service configured with the tag "experimental class".
`activity`	string	Yes	Name of the activity (existing or new).
`activityExist`	boolean	No	Defines whether the activity already exists. Default: `false`.
`idBranch`	int32	No	Identifier of the branch where the class will take place.

Example Request

Frequently Asked Questions

1. How to insert the customer into an existing class?

Set the activityExist parameter to true and provide the correct name of the activity in the activity field.

The system will look for the class at the specified time and add the prospect.

2. Is it necessary to check for existing classes beforehand?

Yes, if you want to insert the customer into an existing class.

Confirm the existence of the activity to avoid errors. If the class does not exist, set activityExist to false to create a new one.

3. What happens if `activityExist` is `true` and the class does not exist?

The system does not create a new class automatically.

In this case, the request may fail, and it will be necessary to review the data.

4. How to create a service with the "Experimental Class" option?

In the service configuration, add the tag "experimental class".

Use the same name for the service in the scheduling request.

5. How to ensure that the prospect exists?

Always consult the endpoint Get prospects before inserting a new prospect.

If it does not exist, use POST prospects to register a new one and obtain the idProspect.

Expected Result

If all steps are followed correctly, the prospect will be scheduled for the desired experimental class. If the class already exists, they will be added to it. Otherwise, a new class will be created.

Final Tips

Always validate if the service and activity exist before scheduling.

Ensure that the service has the tag "experimental class".

Use activityExist: false if you wish to create a new activity.

Support

If you have questions or difficulties, contact our support!

Scheduling a trial lesson

Objective#

Endpoint#

Requirements#

Step by Step#

1. Obtain the Prospect ID#

2. Create a Service with the Experimental Class Tag#

3. Link the Service to the Prospect#

4. Consult or Create the Activity#

5. Schedule the Class#

Example Request#

Frequently Asked Questions#

1. How to insert the customer into an existing class?#

2. Is it necessary to check for existing classes beforehand?#

3. What happens if activityExist is true and the class does not exist?#

4. How to create a service with the "Experimental Class" option?#

5. How to ensure that the prospect exists?#

Expected Result#

Final Tips#

Support#