ZapyFlow/Documentação da APIopenapi.json

Meta Catalogs

Catalogos da Meta

PUT/api/channels/{channelId}/meta-catalog

Escopo exigido: meta_catalog.write

ParâmetroOndeObrigatório
channelIdpathsim

Corpo da requisição

CampoTipoObrigatórioRestrições
catalogIdstringsimmin 1, max 128
confirmReplacebooleannão—
bash
curl -X PUT "https://api.zapyflow.com.br/api/channels/{channelId}/meta-catalog" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respostas
  • 200 — OK

DELETE/api/channels/{channelId}/meta-catalog

Escopo exigido: meta_catalog.write

ParâmetroOndeObrigatório
channelIdpathsim
bash
curl -X DELETE "https://api.zapyflow.com.br/api/channels/{channelId}/meta-catalog" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

POST/api/channels/{channelId}/meta-catalog/sync

Escopo exigido: meta_catalog.write

ParâmetroOndeObrigatório
channelIdpathsim

Corpo da requisição

CampoTipoObrigatórioRestrições
sourceAiAgentIdstringsimmin 1
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/meta-catalog/sync" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respostas
  • 202 — Aceito — enfileirado, ainda não concluído

GET/api/meta-catalog-syncs/{id}

Escopo exigido: meta_catalog.read

ParâmetroOndeObrigatório
idpathsim
bash
curl "https://api.zapyflow.com.br/api/meta-catalog-syncs/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

POST/api/meta-catalog-syncs/{id}/retry

Escopo exigido: meta_catalog.write

ParâmetroOndeObrigatório
idpathsim
bash
curl -X POST "https://api.zapyflow.com.br/api/meta-catalog-syncs/{id}/retry" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/meta-catalogs

Escopo exigido: meta_catalog.read

ParâmetroOndeObrigatório
channelIdquerysim
bash
curl "https://api.zapyflow.com.br/api/meta-catalogs?channelId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/meta-catalogs/products

Escopo exigido: meta_catalog.read

ParâmetroOndeObrigatório
channelIdquerysim
sourceAiAgentIdquerysim
searchquerynão
pagequerynão
limitquerynão
bash
curl "https://api.zapyflow.com.br/api/meta-catalogs/products?channelId=...&sourceAiAgentId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace