Agenda

book_appointment

EscritaPede aprovação

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.

Permissão

scheduling:write

Operação

appointments.book

Módulo

scheduling

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

attendantIdstringobrigatório

serviceIdstringobrigatório

contactIdstringopcional

Contato. Ou newContact, para quem não está na base.

newContactobjectopcional

Cria o contato (ou reusa pelo e-mail/telefone) no lugar de contactId.

newContact.namestringobrigatório

newContact.emailstring (email)opcional

newContact.phonestringopcional

startTimestringobrigatório

Início (ISO 8601; sem fuso = Brasília).

endTimestringobrigatório

Fim, depois do início.

conversationIdstringopcional

Conversa de onde veio o agendamento.

notesstringopcional

Observação interna.

autoMeetLinkbooleanopcional

Gera link do Google Meet na agenda do profissional.

meetingUrlstring (uri)opcional

Link de reunião colado à mão.

sendBotbooleanopcional

Manda o bot de transcrição para a reunião.

allowOutsideAvailabilitybooleanopcional

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

EscritaPede aprovação

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.

Permissão

scheduling:write

Operação

appointments.cancel

Módulo

scheduling

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

appointmentIdstringobrigatório

check_in_appointment

Escrita

Marca que o contato chegou (check-in) num agendamento confirmado; evita que vire "não compareceu" sozinho.

Permissão

scheduling:write

Operação

appointments.checkIn

Módulo

scheduling

Parâmetros

appointmentIdstringobrigatório

find_available_slots

Leitura

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.

Permissão

scheduling:read

Operação

scheduling.slots

Módulo

scheduling

Parâmetros

serviceIdstringobrigatório

datestring (date)obrigatório

Data (AAAA-MM-DD), no fuso de Brasília.

attendantIdstringopcional

Só deste profissional.

get_appointment

Leitura

Um agendamento, com profissional, serviço, contato e página de agendamento.

Permissão

scheduling:read

Operação

appointments.get

Módulo

scheduling

Parâmetros

appointmentIdstringobrigatório

list_appointments

Leitura

Agendamentos, paginados, com profissional, serviço e contato. Filtros: página de agendamento, profissional, contato, status e período (início do atendimento).

Permissão

scheduling:read

Operação

appointments.list

Módulo

scheduling

Parâmetros

bookingPageIdstringopcional

attendantIdstringopcional

contactIdstringopcional

statusstringopcional

RESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETED

fromstringopcional

A partir de (data ou data e hora ISO).

tostringopcional

Até (só a data = até o fim do dia; ou data e hora ISO).

pageintegeropcional

limitintegeropcional

list_booking_pages

Leitura

Páginas de agendamento da empresa: cada uma é um tipo de atendimento que o cliente agenda, com link (slug), serviço e profissional.

Permissão

scheduling:read

Operação

scheduling.bookingPages.list

Módulo

scheduling

Parâmetros

Sem parâmetros.

list_scheduling_services

Leitura

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.

Permissão

scheduling:read

Operação

scheduling.services.list

Módulo

scheduling

Parâmetros

Sem parâmetros.

reschedule_appointment

EscritaPede aprovação

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.

Permissão

scheduling:write

Operação

appointments.reschedule

Módulo

scheduling

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

appointmentIdstringobrigatório

newStartTimestringobrigatório

Novo início (ISO 8601; sem fuso = Brasília).

newEndTimestringobrigatório

Novo fim, depois do início.

allowOutsideAvailabilitybooleanopcional

Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente.

notifyContactbooleanopcional

Avisa o contato da mudança por e-mail/WhatsApp.

set_appointment_status

EscritaPede aprovação

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.

Permissão

scheduling:write

Operação

appointments.status

Módulo

scheduling

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

appointmentIdstringobrigatório

statusstringobrigatório

RESERVEDCONFIRMEDCANCELLEDNO_SHOWCOMPLETED

update_appointment

EscritaPede aprovação

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.

Permissão

scheduling:write

Operação

appointments.update

Módulo

scheduling

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

appointmentIdstringobrigatório

startTimestringopcional

endTimestringopcional

attendantIdstringopcional

serviceIdstringopcional

contactIdstringopcional

notesstringopcional

Nulo limpa.

allowOutsideAvailabilitybooleanopcional

Encaixa fora do expediente, folga ou feriado (nunca libera choque de agenda). Só vale no painel; ignorado para chave de API e agente.

notifyContactbooleanopcional

Avisa o contato da mudança por e-mail/WhatsApp.