What the API is for
Everything you do in the app is stored as records — a lead, a chatroom, an AI flow, an appointment. The Developer API exposes those records over HTTPS so that something other than a person at the keyboard can work with them:
- AI agents (Claude, ChatGPT-based agents, your own assistants) that qualify leads, write follow-up sequences or tidy knowledge for you.
- Integrations that push leads in from another system, pull appointments into a calendar, or sync tags.
- Scripts for one-off imports, exports and clean-ups.
It is a data API: create, read, update and delete. Sending a WhatsApp message, starting a broadcast or running a workflow are actions that stay in the app for now.
How it works
- A signed-in user creates a personal token on AI and Automation → API Tokens, choosing which resources it may read or change and when it expires.
- Your script or agent sends that token on every request. The API acts as that user, inside that user's workspace — it can never see another workspace.
- All requests go to one base URL with a version prefix, and every resource follows the same shape: list, read, create, update, delete.
curl https://api2.djcsystem.com/v1/me -H "Authorization: Bearer $DJC_TOKEN"| Base URL | https://api2.djcsystem.com/v1 |
| Authentication | Authorization: Bearer djc_… or X-API-Key: djc_… |
| Format | JSON in, JSON out. Dates are ISO-8601 strings in UTC. |
| Versioning | The path carries the version (/v1). Breaking changes ship as a new version; additive changes do not. |
| Release | 2026-09 |
What you can access
Each resource is a kind of record. The list below is generated from the API itself; open a resource for its fields, filters and rules.
| Resource | What it holds | Operations |
|---|---|---|
| leads | Contacts captured from WhatsApp, Facebook, forms and imports — the core CRM record. | GET POST PATCH DELETE |
| chatrooms | Inbox conversations. Read the room and its messages; update status, name and AI handling. Rooms are created by incoming traffic, not by the API. | GET PATCH |
| ai-flows | WhatsApp AI chatbot designs: persona (`system`), knowledge (`flowDesign`), trigger keywords and assignment rules. | GET POST PATCH DELETE |
| knowledge-records | Text snippets embedded for retrieval by AI flows (the RAG source). Each record belongs to a flow and a catalog. | GET POST PATCH DELETE |
| catalogs | Groupings of knowledge records inside a flow. | GET POST PATCH DELETE |
| workflows | Node-based automations (trigger → actions). Nodes and edges are exposed as read-only children. | GET POST PATCH DELETE |
| appointments | Calendar bookings with a customer, including reminders. | GET POST PATCH DELETE |
| event-types | Bookable appointment templates (duration, working hours, capacity). | GET POST PATCH DELETE |
| blast-campaigns | WhatsApp broadcast campaigns and their message variants. | GET POST PATCH DELETE |
| scheduled-tasks | One-off scheduled WhatsApp messages and reminders. | GET POST PATCH DELETE |
| forms | Lead-capture forms and their field definitions. | GET POST PATCH DELETE |
Start here
Authentication & tokens
Create a token, understand scopes, expiry and revocation.
Quickstart
From token to your first created lead in five calls.
Requests, filters & paging
The five operations every resource shares, with samples.
Guides for AI agents
Plain-Markdown guides you can paste into an agent's context.
Using an AI agent?
Create the token, press Copy JSON on the token page, and paste it into your agent together with the agent guide. The agent's first two calls should be GET /me and GET /resources.