Product guides
API keys
To use the Wbiztool API, or an integration that asks for your credentials, you need three things from the dashboard:
| Credential | API field | Where to find it |
|---|---|---|
| API Client ID | client_id | Settings → API Keys, at the top of the page |
| API key | api_key | Settings → API Keys |
| WhatsApp Client ID | whatsapp_client | The Whatsapp Client ID column on WhatsApp settings |
Before you start#
- You must be an Administrator of the workspace to see, create or delete API keys. See Roles and permissions.
- Select the right workspace first. Keys belong to the workspace that's selected when you create them, and API requests made with a key act on that workspace. See Switch workspace.
- Demo accounts can't use the API.
Find your API Client ID#
Open Settings → API Keys. The API Overview card shows API Client ID: followed by a number. Use this number as client_id in every request. It's the same for every key in the workspace.
Create an API key#
Open API Keys
Go to Settings and click the API Keys tab, or open /settings/#api-keys directly.
Create the key
Under New API Key, click Create New. A success message confirms the key was generated, and it appears in the table.
Copy the full key
The API Key column only shows the start and end of each key. Click the copy button next to it (Copy Full API Key) to copy the full key, then paste it into your app or integration.
Keys are named automatically from how many keys the workspace has (API Key 1, API Key 2 and so on) and can't be renamed. After you delete a key, a new key can get the same name as an existing one, so tell keys apart by their first and last characters and the Created date. Keys don't expire: a key works until you delete it.
Limit#
A workspace can have up to 10 API keys at a time. When you reach the limit, you see "You have reached the maximum limit of 10 API keys per organization." Delete a key you no longer use to create a new one.
The API keys table#
| Column | Meaning |
|---|---|
| Label | The key's name, such as API Key 1. |
| API Key | The first and last characters of the key. Use the copy button for the full key. |
| Created | The date the key was created. |
| Status | Always Active. Deleted keys are removed from the table. |
| Actions | Delete removes the key. |
Delete an API key#
Find the key
On Settings → API Keys, find the key in the table.
Delete it
Click Delete, then Yes, Delete API Key.
Deleting a key can't be undone. Any app still using it stops working immediately and gets Auth Error: invalid api key. Update your apps with a new key first.
WhatsApp Client IDs#
Each connected WhatsApp number has its own ID. Most messaging endpoints need it in the whatsapp_client field to choose which number sends the message.
Open WhatsApp settings and read the Whatsapp Client ID column next to each number. See Connect your WhatsApp number if you haven't connected one yet.
Test your credentials#
Call Check credentials (POST /api/v1/me/) with your client_id and api_key, and optionally a whatsapp_client. It confirms they work together without sending anything or using any messages. If the whatsapp_client doesn't belong to the workspace, the response is Invalid WhatsApp Client ID.
If an API key leaks#
Anyone with your API key and API Client ID can send messages from your WhatsApp numbers and use your workspace's messages.
Create a replacement key
On Settings → API Keys, click Create New and copy the new key.
Update your apps
Replace the old key in every app and integration that used it.
Delete the leaked key
Click Delete on the leaked key. It stops working immediately.
Check for misuse
Review recent messages on Reports for anything you didn't send.
Also treat the email "WbizTool Alert - WhatsApp Connected Successfully!" as secret: it's sent to the workspace creator when a number first connects and can include one of your API keys.
Troubleshooting#
| Problem | What to check |
|---|---|
| API Keys tab shows No API Keys Found, but keys exist | You're not an Administrator in this workspace, or a different workspace is selected. |
| "You don't have permission to create API keys in this space." | Only Administrators can create or delete keys. The Generate New API Key button in an empty table appears for everyone, but only works for Administrators. |
| "You have reached the maximum limit of 10 API keys per organization." | Delete a key you no longer use. |
Auth Error: invalid api key | The key was deleted or mistyped, or the client_id doesn't belong to the same workspace as the key. If a new key and the API Client ID shown on the page still fail, contact support (older workspaces can show an API Client ID that only works with keys created by the workspace creator). |
Auth Error - Please send correct API key and Client id | api_key is missing from the request. |
Invalid client id. (or Invalid Client Id on some endpoints) | client_id is missing or isn't a number. On Check credentials, a missing client_id or api_key returns just Auth Error; Invalid Client Id there means it isn't a number. Copy it from the API Overview card. |
| Requests act on the wrong workspace | The key was created in another workspace. Switch workspace and create a key there. |
Demo Account can not access apis | Demo accounts can't use the API. Sign up for a free account. |