ZapyFlow/API documentationopenapi.json

Channels

WhatsApp channels

GET/api/channels

Required scope: channels.read

ParameterInRequired
searchqueryno
includeDeactivatedqueryno
bash
curl "https://api.zapyflow.com.br/api/channels" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

POST/api/channels

Required scope: channels.write

Request body

FieldTypeRequiredConstraints
namestringyesmin 2, max 120
provider"BAILEYS" | "CLOUD_API"yes—
bash
curl -X POST "https://api.zapyflow.com.br/api/channels" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Responses
  • 201 — Created
  • 403 — Forbidden, or the key lacks this scope

GET/api/channels/{id}

Required scope: channels.read

ParameterInRequired
idpathyes
bash
curl "https://api.zapyflow.com.br/api/channels/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 404 — Not found — also returned when the resource belongs to another workspace

PATCH/api/channels/{id}

Required scope: channels.write

ParameterInRequired
idpathyes

Request body

FieldTypeRequiredConstraints
namestringyesmin 2, max 120
bash
curl -X PATCH "https://api.zapyflow.com.br/api/channels/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Responses
  • 200 — OK

PUT/api/channels/{id}/ai-agent

Required scope: channels.write

ParameterInRequired
idpathyes

Request body

FieldTypeRequiredConstraints
aiAgentIdstringyesmin 1
bash
curl -X PUT "https://api.zapyflow.com.br/api/channels/{id}/ai-agent" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Responses
  • 200 — OK
  • 404 — Not found — also returned when the resource belongs to another workspace

DELETE/api/channels/{id}/ai-agent

Required scope: channels.write

ParameterInRequired
idpathyes
bash
curl -X DELETE "https://api.zapyflow.com.br/api/channels/{id}/ai-agent" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/channels/{id}/business-verification

Required scope: channels.read

ParameterInRequired
idpathyes
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/business-verification" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

POST/api/channels/{id}/deactivate

Required scope: channels.write

ParameterInRequired
idpathyes
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/deactivate" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/channels/{id}/health

Required scope: channels.read

ParameterInRequired
idpathyes
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/health" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

GET/api/channels/{id}/meta/templates

Required scope: channels.read

ParameterInRequired
idpathyes
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/meta/templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK
  • 400 — Malformed request
  • 404 — Not found — also returned when the resource belongs to another workspace
  • 502 — Upstream provider failed

GET/api/channels/{id}/qr

Required scope: channels.read

ParameterInRequired
refreshqueryno
idpathyes
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/qr" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK

POST/api/channels/{id}/reactivate

Required scope: channels.write

ParameterInRequired
idpathyes
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/reactivate" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Responses
  • 200 — OK