Postman Collection

Test the CubeConnect API directly from Postman with our official collection.

Download

Download CubeConnect.postman_collection.json

Or import directly using this URL:

https://docs.cubeconnect.io/CubeConnect.postman_collection.json

What's Included

Folder	Requests	Description
Health Check	1	Platform health status (no auth)
Messages	3	Send template (with/without params), Arabic template
Conversations	2	List and get conversations
Customers	2	List and get customers
Templates	2	List and get templates
Error Examples	3	Test 401, 422 error responses

Total: 13 requests with saved example responses.

Setup

1. Import the Collection

1. Open Postman
2. Click Import (top left)
3. Drag the downloaded JSON file or paste the URL
4. Click Import

2. Set Your API Key

1. Click the CubeConnect API collection name
2. Go to the Variables tab
3. Set api_key to your API key from the dashboard
4. Set phone to a valid WhatsApp number (e.g., +966501234567)
5. Click Save

Variable	Default	Description
base_url	https://cubeconnect.io	API base URL
api_key	YOUR_API_KEY	Your API key
tenant_id	(empty)	Optional — for multi-tenant accounts
phone	+966501234567	Default recipient phone

3. Start Testing

Click Send on any request. Start with Health Check to verify connectivity.

Quick Test Flow

1. Health Check — Verify the platform is running
2. Send Template (no params) — Send a simple template (works anytime)
3. Send Template (with params) — Send a template with parameters
4. List Conversations — View your conversations
5. Error Examples — See how errors are returned

Multi-Tenant

If your account uses multi-tenant mode:

1. Set the tenant_id variable
2. The collection auto-injects X-TENANT-ID header via a pre-request script

Authentication

The collection uses Bearer Token authentication at the collection level. All requests inherit it automatically.

To test with X-API-KEY header instead:

1. Set collection auth to No Auth
2. Add header X-API-KEY: to individual requests

Error Testing

The Error Examples folder contains ready-made requests that intentionally trigger errors:

• 401 — Invalid API Key: Uses a fake key
• 401 — No API Key: Sends without authentication
• 422 — Validation Error: Sends empty required fields

Use these to test your error handling logic.