API Management
The API Management feature in WhatsMark allows you to integrate your system with other applications. By using API tokens, you can automate tasks, manage contacts, statuses, and sources without manually entering data. This feature helps you connect WhatsMark, third-party tools, or any custom software.
1. Enabling API Access
- To start using the API, you need to enable API access in the system settings.
- Toggle the Enable API Access switch to turn on API access.
- Once enabled, you can generate an API Token for authentication.
2. Generating an API Token
- An API Token is a unique key that allows external applications to connect securely with WhatsMark.
How to Generate a Token:
- Click the Generate New Token button.
- A unique API token will appear – copy it immediately as it won’t be visible again.
- Use this token when making API requests to authenticate your application.
TIP
Treat your API token like a password. Keep it secure and do not share it.
3. Understanding API Token Permissions
API tokens come with different permission levels to control what actions can be performed.
| Operation | Description |
|---|---|
| Create | Add new contacts, statuses, or sources. |
| Read | Retrieve existing contacts, statuses, or sources. |
| Update | Modify contact, status, or source details. |
| Delete | Remove contacts, statuses, or sources. |
- You can view the token abilities under the Token Abilities section in API settings.
4. Using API Commands
To interact with WhatsMark using APIs, you need to use the correct API commands. These commands help you create, read, update, and delete records via API.
API Endpoints
| Action | API Endpoint | Function |
|---|---|---|
| POST | /api/v1/contacts | Create a new contact |
| GET | /api/v1/contacts | List all contacts |
| PUT | /api/v1/contacts/{id} | Update an existing contact |
| DELETE | /api/v1/contacts/{id} | Delete a contact |
- Similar commands exist for statuses and sources as well. you can view all commands in above image.
5. Testing API Requests
To check if the API is working correctly, you can use Postman or any API testing tool.
How to Test API with Postman:
Open Postman and create a new request.
Select the correct method (GET, POST, PUT, DELETE).
Enter the API endpoint (e.g.,
/api/v1/contacts).Add the API Token in the Authorization Header.
Click Send to execute the request and check the response.