In this area
Scheduling
11 tools
book_appointment
WriteNeeds approval
Agenda um atendimento para um contato, com profissional, serviço e horário (confira antes em find_available_slots). Vinda de chave de API ou de agente, NÃO executa na hora: vira pedido na fila de aprovação e só acontece quando um administrador aprova. Avise que está aguardando aprovação.
- Permission
scheduling:write- Operation
appointments.book- Module
scheduling
Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.
Parameters
attendantIdstringrequiredserviceIdstringrequiredcontactIdstringoptional- Contato. Ou newContact, para quem não está na base.
newContactobjectoptional- Cria o contato (ou reusa pelo e-mail/telefone) no lugar de contactId.
newContact.namestringrequirednewContact.emailstring (email)optionalnewContact.phonestringoptionalstartTimestringrequired- Início (ISO 8601; sem fuso = Brasília).
endTimestringrequired- Fim, depois do início.
conversationIdstringoptional- Conversa de onde veio o agendamento.
notesstringoptional- Observação interna.
autoMeetLinkbooleanoptional- Gera link do Google Meet na agenda do profissional.
meetingUrlstring (uri)optional- Link de reunião colado à mão.
sendBotbooleanoptional- Manda o bot de transcrição para a reunião.
allowOutsideAvailabilitybooleanoptional- Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente.
| Field | Type | Description |
|---|---|---|
attendantIdrequired | string | |
serviceIdrequired | string | |
contactIdoptional | string | Contato. Ou newContact, para quem não está na base. |
newContactoptional | object | Cria o contato (ou reusa pelo e-mail/telefone) no lugar de contactId. |
newContact.namerequired | string | |
newContact.emailoptional | string (email) | |
newContact.phoneoptional | string | |
startTimerequired | string | Início (ISO 8601; sem fuso = Brasília). |
endTimerequired | string | Fim, depois do início. |
conversationIdoptional | string | Conversa de onde veio o agendamento. |
notesoptional | string | Observação interna. |
autoMeetLinkoptional | boolean | Gera link do Google Meet na agenda do profissional. |
meetingUrloptional | string (uri) | Link de reunião colado à mão. |
sendBotoptional | boolean | Manda o bot de transcrição para a reunião. |
allowOutsideAvailabilityoptional | boolean | Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente. |
cancel_appointment
WriteNeeds approval
Cancela um agendamento (libera o horário e avisa o contato, se configurado). Vinda de chave de API ou de agente, NÃO executa na hora: vira pedido na fila de aprovação e só acontece quando um administrador aprova. Avise que está aguardando aprovação.
- Permission
scheduling:write- Operation
appointments.cancel- Module
scheduling
Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.
Parameters
appointmentIdstringrequired
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string |
check_in_appointment
Write
Marca que o contato chegou (check-in) num agendamento confirmado; evita que vire "não compareceu" sozinho.
- Permission
scheduling:write- Operation
appointments.checkIn- Module
scheduling
Parameters
appointmentIdstringrequired
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string |
find_available_slots
Read
Horários livres de um serviço numa data, considerando expediente, folgas, feriados, bloqueios, outros agendamentos e o Google Agenda do profissional. Use antes de agendar ou remarcar.
- Permission
scheduling:read- Operation
scheduling.slots- Module
scheduling
Parameters
serviceIdstringrequireddatestring (date)required- Data (AAAA-MM-DD), no fuso de Brasília.
attendantIdstringoptional- Só deste profissional.
| Field | Type | Description |
|---|---|---|
serviceIdrequired | string | |
daterequired | string (date) | Data (AAAA-MM-DD), no fuso de Brasília. |
attendantIdoptional | string | Só deste profissional. |
get_appointment
Read
Um agendamento, com profissional, serviço, contato e página de agendamento.
- Permission
scheduling:read- Operation
appointments.get- Module
scheduling
Parameters
appointmentIdstringrequired
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string |
list_appointments
Read
Agendamentos, paginados, com profissional, serviço e contato. Filtros: página de agendamento, profissional, contato, status e período (início do atendimento).
- Permission
scheduling:read- Operation
appointments.list- Module
scheduling
Parameters
bookingPageIdstringoptionalattendantIdstringoptionalcontactIdstringoptionalstatusstringoptionalRESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETEDfromstringoptional- A partir de (data ou data e hora ISO).
tostringoptional- Até (só a data = até o fim do dia; ou data e hora ISO).
pageintegeroptionallimitintegeroptional
| Field | Type | Description |
|---|---|---|
bookingPageIdoptional | string | |
attendantIdoptional | string | |
contactIdoptional | string | |
statusoptional | string | RESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETED |
fromoptional | string | A partir de (data ou data e hora ISO). |
tooptional | string | Até (só a data = até o fim do dia; ou data e hora ISO). |
pageoptional | integer | |
limitoptional | integer |
list_booking_pages
Read
Páginas de agendamento da empresa: cada uma é um tipo de atendimento que o cliente agenda, com link (slug), serviço e profissional.
- Permission
scheduling:read- Operation
scheduling.bookingPages.list- Module
scheduling
Parameters
No parameters.
list_scheduling_services
Read
Serviços agendáveis (duração e preço) com os profissionais que atendem cada um. Use para achar serviceId e attendantId antes de ver horários ou agendar.
- Permission
scheduling:read- Operation
scheduling.services.list- Module
scheduling
Parameters
No parameters.
reschedule_appointment
WriteNeeds approval
Remarca um agendamento para outro horário (confira antes em find_available_slots). O agendamento remarcado ganha um novo id. Vinda de chave de API ou de agente, NÃO executa na hora: vira pedido na fila de aprovação e só acontece quando um administrador aprova. Avise que está aguardando aprovação.
- Permission
scheduling:write- Operation
appointments.reschedule- Module
scheduling
Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.
Parameters
appointmentIdstringrequirednewStartTimestringrequired- Novo início (ISO 8601; sem fuso = Brasília).
newEndTimestringrequired- Novo fim, depois do início.
allowOutsideAvailabilitybooleanoptional- Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente.
notifyContactbooleanoptional- Avisa o contato da mudança por e-mail/WhatsApp.
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string | |
newStartTimerequired | string | Novo início (ISO 8601; sem fuso = Brasília). |
newEndTimerequired | string | Novo fim, depois do início. |
allowOutsideAvailabilityoptional | boolean | Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente. |
notifyContactoptional | boolean | Avisa o contato da mudança por e-mail/WhatsApp. |
set_appointment_status
WriteNeeds approval
Muda o status de um agendamento: confirmado, concluído, não compareceu ou cancelado (cancelar avisa o contato). Vinda de chave de API ou de agente, NÃO executa na hora: vira pedido na fila de aprovação e só acontece quando um administrador aprova. Avise que está aguardando aprovação.
- Permission
scheduling:write- Operation
appointments.status- Module
scheduling
Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.
Parameters
appointmentIdstringrequiredstatusstringrequiredRESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETED
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string | |
statusrequired | string | RESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETED |
update_appointment
WriteNeeds approval
Edita um agendamento: horário, profissional, serviço, contato ou observação. Mudar horário ou profissional remarca (novo id); o resto edita no lugar, sem avisar o cliente. Vinda de chave de API ou de agente, NÃO executa na hora: vira pedido na fila de aprovação e só acontece quando um administrador aprova. Avise que está aguardando aprovação.
- Permission
scheduling:write- Operation
appointments.update- Module
scheduling
Tools that wait for approval don't run right away: they become a request in To review and in the AI approvals tab.
Parameters
appointmentIdstringrequiredstartTimestringoptionalendTimestringoptionalattendantIdstringoptionalserviceIdstringoptionalcontactIdstringoptionalnotesstringoptional- Nulo limpa.
allowOutsideAvailabilitybooleanoptional- Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente.
notifyContactbooleanoptional- Avisa o contato da mudança por e-mail/WhatsApp.
| Field | Type | Description |
|---|---|---|
appointmentIdrequired | string | |
startTimeoptional | string | |
endTimeoptional | string | |
attendantIdoptional | string | |
serviceIdoptional | string | |
contactIdoptional | string | |
notesoptional | string | Nulo limpa. |
allowOutsideAvailabilityoptional | boolean | Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente. |
notifyContactoptional | boolean | Avisa o contato da mudança por e-mail/WhatsApp. |