API Overview

The ChatBreeZ API is a RESTful API designed to help developers integrate WhatsApp messaging into their applications.

Base URL

All API requests should be made to the following base URL:

https://api.chatbreez.com

Authentication

Authentication is handled via the X-API-Key header. You must include your API Key in every request.

Header	Description
X-API-Key	Your secret API key found in the ChatBreeZ dashboard.

Example Header

X-API-Key: your_api_key_here
Content-Type: application/json

Instances

The API uses an :instance parameter in the URL. This is the unique name you gave to your WhatsApp instance when you created it in the dashboard.

Example: https://api.chatbreez.com/whatsapp/send-text/my-instance-name

Error Handling

The API returns standard HTTP status codes to indicate the success or failure of a request.

• 201 Created: Message successfully sent or resource created.
• 400 Bad Request: Missing parameters or invalid data.
• 401 Unauthorized: Missing or invalid API Key.
• 500 Internal Server Error: An error occurred on our end.