ZapyFlow/Documentación de la APIopenapi.json

Settings

Configuración del workspace y del equipo

GET/api/settings/capabilities

Capacidades de quien llama y la matriz de roles del workspace

Ámbito requerido: team.read

bash
curl "https://api.zapyflow.com.br/api/settings/capabilities" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/settings/invitations

Invitaciones del equipo

Ámbito requerido: team.read

bash
curl "https://api.zapyflow.com.br/api/settings/invitations" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/settings/service-policy

Política de atención del equipo

Ámbito requerido: service_policy.read

ParámetroDóndeObligatorio
aiAgentIdqueryno
bash
curl "https://api.zapyflow.com.br/api/settings/service-policy" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

PATCH/api/settings/service-policy

Actualizar la política de atención del equipo

Ámbito requerido: service_policy.write

Cuerpo de la petición

CampoTipoObligatorioRestricciones
timezonestringnullsí—
businessHoursobject | nullno—
inactivityTimeoutMinutesinteger | nullsí—
inactivityFarewellstringnullsí—
sourceobjectsí—
commercialobjectsí—
bash
curl -X PATCH "https://api.zapyflow.com.br/api/settings/service-policy" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 400 — Petición malformada

GET/api/settings/team

Datos del equipo, con la lista de miembros

Ámbito requerido: team.read

bash
curl "https://api.zapyflow.com.br/api/settings/team" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK