Agendamento de aula experimental
Objetivo#
Realizar um agendamento de aula experimental para um prospect, criando ou vinculando a uma aula existente.Endpoint#
POST /api/v1/activities/schedule-experimental-classRequisitos#
idProspect: Identificador do prospect que participará da aula.
service: Prospect deve estar vinculado a um serviço configurado com a tag aula experimental.
activity: Nome da atividade que será criada ou utilizada para a aula.
activityExist: Define se a atividade já existe (true ou false).
activityDate: Data e hora da aula experimental no formato yyyy-MM-dd HH:mm.
Passo a Passo#
1. Obtenha o ID do Prospect#
Certifique-se de que o prospect existe no sistema. Caso contrário, insira um novo prospect pelo endpoint POST prospects.
Crie um serviço com a tag "aula experimental".
Certifique-se de que o serviço tenha preço zero, pois trata-se de uma aula gratuita.
Nome do serviço: Aula Experimental de Yoga
3. Vincule o Serviço ao Prospect#
Para associar o serviço ao prospect, gere uma venda sem valor.
4. Consulte ou Crie a Atividade#
Utilize o parâmetro activityExist como true e forneça o nome correto da atividade no campo activity.
O sistema buscará a aula existente no horário especificado.
Utilize o parâmetro activityExist como false.
O sistema criará uma nova atividade no horário especificado.
Caso activityExist seja true e a aula não exista no horário informado, o sistema não cria automaticamente uma nova aula. Certifique-se de validar os dados da atividade.5. Realize o Agendamento#
Adicione os seguintes parâmetros na requisição:| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
idProspect | int32 | Sim | Identificador do prospect. |
activityDate | date-time | Sim | Data e hora no formato yyyy-MM-dd HH:mm. |
service | string | Sim | Nome do serviço configurado com a tag "aula experimental". |
activity | string | Sim | Nome da atividade (existente ou nova). |
activityExist | boolean | Não | Define se a atividade já existe. Padrão: false. |
idBranch | int32 | Não | Identificador da filial onde ocorrerá a aula. |
Exemplo de Requisição#
Perguntas Frequentes#
1. Como inserir o cliente em uma aula já existente?#
Defina o parâmetro activityExist como true e forneça o nome correto da atividade no campo activity.
O sistema buscará a aula no horário especificado e adicionará o prospect.
2. É necessário buscar as aulas existentes antes?#
Sim, caso você deseje inserir o cliente em uma aula já existente.
Confirme a existência da atividade para evitar erros. Caso a aula não exista, defina activityExist como false para criar uma nova.
3. O que acontece seactivityExist for true e a aula não existir?#
O sistema não cria automaticamente uma nova aula.
Neste caso, a requisição pode falhar, e será necessário revisar os dados.
Na configuração do serviço, adicione a tag "aula experimental".
Utilize o mesmo nome do serviço na requisição para agendamento.
5. Como garantir que o prospect existe?#
Sempre consulte o endpoint Get prospects antes de inserir um novo prospect. Caso não exista, utilize o POST prospects para cadastrar um novo e obter o idProspect.
Resultado Esperado#
Se todas as etapas forem seguidas corretamente, o prospect será agendado para a aula experimental desejada. Caso a aula já exista, ele será adicionado a ela. Caso contrário, uma nova aula será criada.Dicas Finais#
Sempre valide se o serviço e a atividade existem antes do agendamento.
Garanta que o serviço tenha a tag "aula experimental".
Utilize activityExist: false caso deseje criar uma nova atividade.
Suporte#
Se você tiver dúvidas ou dificuldades, fale com o nosso suporte!Modified at 2026-05-15 03:49:27
