ZapyFlow/Documentação da APIopenapi.json

Settings

Configuracoes do workspace e da equipe

GET/api/settings/capabilities

Capacidades do chamador e a matriz de papéis do workspace

Escopo exigido: team.read

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

GET/api/settings/invitations

Convites do time

Escopo exigido: team.read

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

GET/api/settings/service-policy

Política de atendimento do time

Escopo exigido: service_policy.read

ParâmetroOndeObrigatório
aiAgentIdquerynão
bash
curl "https://api.zapyflow.com.br/api/settings/service-policy" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

PATCH/api/settings/service-policy

Atualizar a política de atendimento do time

Escopo exigido: service_policy.write

Corpo da requisição

CampoTipoObrigatórioRestrições
timezonestringnullsim—
businessHoursobject | nullnão—
inactivityTimeoutMinutesinteger | nullsim—
inactivityFarewellstringnullsim—
sourceobjectsim—
commercialobjectsim—
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 '{ ... }'
Respostas
  • 200 — OK
  • 400 — Requisição malformada

GET/api/settings/team

Dados do time com lista de membros

Escopo exigido: team.read

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