Appointments
Agenda e agendamentos
GET/api/appointments
Listar agendamentos do time
Escopo exigido: appointments.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
page | query | não |
limit | query | não |
aiAgentId | query | não |
status | query | não |
source | query | não |
dateFrom | query | não |
dateTo | query | não |
search | query | não |
sort | query | não |
overlap | query | não |
bash
curl "https://api.zapyflow.com.br/api/appointments" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK400— Requisição malformada
POST/api/appointments
Criar agendamento (via painel ou IA). Devolve 409 quando o horário já está ocupado; reenvie com allowOverlap para marcar mesmo assim.
Escopo exigido: appointments.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
aiAgentId | string | sim | min 1 |
title | string | sim | min 1, max 255 |
startTime | string | sim | — |
endTime | string | sim | — |
status | "PENDING" | "CONFIRMED" | "CANCELLED" | "COMPLETED" | não | — |
notes | string | não | max 500 |
source | "BOT" | "DASHBOARD" | não | — |
leadId | string | não | — |
clientName | string | não | max 255 |
clientPhone | string | não | — |
clientEmail | string | não | — |
allowOverlap | boolean | não | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/appointments" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado400— Requisição malformada409— Conflito com o estado atual
PATCH/api/appointments/{id}
Atualizar agendamento
Escopo exigido: appointments.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
title | string | não | min 1, max 255 |
startTime | string | não | — |
endTime | string | não | — |
status | "PENDING" | "CONFIRMED" | "CANCELLED" | "COMPLETED" | não | — |
notes | string | null | não | — |
notifyClient | boolean | não | — |
allowOverlap | boolean | não | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/appointments/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
DELETE/api/appointments/{id}
Deletar agendamento
Escopo exigido: appointments.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/appointments/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace