Appointments
Agenda y citas
GET/api/appointments
Listar las citas del equipo
Ámbito requerido: appointments.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
page | query | no |
limit | query | no |
aiAgentId | query | no |
status | query | no |
source | query | no |
dateFrom | query | no |
dateTo | query | no |
search | query | no |
sort | query | no |
overlap | query | no |
bash
curl "https://api.zapyflow.com.br/api/appointments" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK400— Petición malformada
POST/api/appointments
Crear una cita (desde el panel o la IA). Devuelve 409 cuando el horario ya está ocupado; reenvía con allowOverlap para agendar igual.
Ámbito requerido: appointments.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
aiAgentId | string | sí | min 1 |
title | string | sí | min 1, max 255 |
startTime | string | sí | — |
endTime | string | sí | — |
status | "PENDING" | "CONFIRMED" | "CANCELLED" | "COMPLETED" | no | — |
notes | string | no | max 500 |
source | "BOT" | "DASHBOARD" | no | — |
leadId | string | no | — |
clientName | string | no | max 255 |
clientPhone | string | no | — |
clientEmail | string | no | — |
allowOverlap | boolean | no | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/appointments" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado400— Petición malformada409— Conflicto con el estado actual
PATCH/api/appointments/{id}
Actualizar una cita
Ámbito requerido: appointments.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
title | string | no | min 1, max 255 |
startTime | string | no | — |
endTime | string | no | — |
status | "PENDING" | "CONFIRMED" | "CANCELLED" | "COMPLETED" | no | — |
notes | string | null | no | — |
notifyClient | boolean | no | — |
allowOverlap | boolean | no | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/appointments/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
200— OK400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
DELETE/api/appointments/{id}
Eliminar una cita
Ámbito requerido: appointments.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/appointments/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace