WhatsApp API Platform
Chatbots

Activate chatbot flow

POST
/api/v1/chatbots/{id}/activate

Compile and activate the chatbot's current flow. Returns the newly activated flow version.

Authorization

ApiKeyAuth
X-API-Key<token>

API key from your dashboard (Settings > API Keys)

In: header

Path Parameters

id*string

Chatbot ID (cuid2)

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/chatbots/cbt_abc123/activate"
{
  "success": true,
  "data": {
    "id": "string",
    "chatbot_id": "string",
    "version_number": 0,
    "status": "string",
    "start_node_id": "string",
    "activated_at": "2019-08-24T14:15:22Z",
    "superseded_at": "2019-08-24T14:15:22Z"
  }
}
{
  "success": false,
  "message": "to field is required"
}
{
  "success": false,
  "message": "user not authenticated"
}
{
  "success": false,
  "message": "Chatbot not found"
}
{
  "success": false,
  "message": "internal server error"
}

Show Typing Indicator POST

Show a "typing…" indicator on the recipient's chat. Use it while your bot or agent composes a reply, so the wait reads as activity rather than silence. The indicator expires on its own after a few seconds, or as soon as your next message arrives — there is nothing to clear. Best-effort by design: a provider that declines still returns `200`, because a missing indicator should never fail the flow that was about to send a real message. The body's `sent` tells you whether it actually reached the recipient, and `reason` names the gate when it did not. Only an unrecognised `to` returns an error. **Requires a recipient who has messaged you within the last 24 hours.** WhatsApp only permits an indicator in reply to a recent inbound message: a number with no chat history returns `404`, and one whose last message has aged out returns `200` with `"reason": "no_recent_inbound_message"`.

Create chatbot POST

Create a new chatbot. A successful create returns the chatbot in `DRAFT` status; build its flow from the dashboard, then activate it.