Skip to main content

API Reference

Welcome to the Z-API API reference! Here you will find all available endpoints to interact with WhatsApp through our platform.

Base URL

All requests must be made to the following base URL:
https://api.z-api.io/instances/{instanceId}/token/{token}
ParameterDescription
instanceIdYour instance ID, obtained from the Z-API panel
tokenYour instance token, obtained from the Z-API panel

Authentication

In addition to the ID and Token in the URL, all requests require the security header:
HeaderDescription
Client-TokenAccount security token. Learn more

Request format

  • All requests must include the Content-Type: application/json header
  • Request and response bodies are in JSON format

Common response codes

CodeDescription
200Request completed successfully
400Invalid request. Check the data sent
405Incorrect HTTP method
415Content-Type header not provided