WhatsApp API OpenAPI spec and Postman collection

How to import

1. Postman: Import, then File (or Link, pasting the file URL). The collection has the variables baseUrl, apiKey, apiSecret and instanceId; fill them in the Variables tab.
2. Insomnia, Bruno and Hoppscotch: import the OpenAPI file or the Postman collection from the import menu.
3. Typed client: generate an SDK with OpenAPI Generator, for example npx @openapitools/openapi-generator-cli generate -i zapzap-openapi.en.json -g typescript-fetch -o ./zapzap-client.

Authentication

Every request carries the x-api-key and x-api-secret headers, which you copy from Settings and API in the dashboard. The base URL is https://api.zapzapapi.com/api/v1.

Example: send a text

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/send/text" \
  -H "x-api-key: SUA_CHAVE" \
  -H "x-api-secret: SEU_SEGREDO" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","text":"Hello!"}'

How these files are generated

A script (scripts/gerar-openapi.mjs) reads the site's API reference and builds the OpenAPI file and the Postman collection. It fails if the operation count diverges from the source or between languages, and it masks any phone number that is not clearly fictional.

No endpoint is written by hand: what is in the reference is in the files, and nothing else. Each request in the collection uses the reference's required parameters as an example.

Reference by endpointQuickstartAPI WhatsAppPricing

Frequently asked questions