WhatsAble
Get Started
GuidesAPI Reference
API v1AI bots

Switch the AI off or on in a conversation

patchhttps://api.whatsable.app/v1/conversations/{id}/ai
Build a request to copy

This page never sends a request. Fill in the fields, then copy the request and run it from your server.

Request
curl -X PATCH 'https://api.whatsable.app/v1/conversations/string/ai' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "off"
}'

Authorization

bearerAuth
headerAuthorizationBearer <nfy_live_<32 characters>>

An API key from Settings > API keys, sent as Authorization: Bearer <key>.

Path Parameters

id*string

The conversation id.

Length1 <= length <= 64

Request Body

application/json
  1. body

Switch the AI off or back on in one conversation.

status*string

off stops the AI in this conversation; active lets it answer again, also after a person took over or the bot handed off.

Value in"active""off"

Response Body

The conversation, with its ai.

application/json
  1. response

One customer on one of the business numbers. One person writing to two numbers has two conversations.

object*string
id*string
Length1 <= length <= 64
number_id*string

The business number of the conversation.

Length1 <= length <= 64
contact_id*string
Length1 <= length <= 64
last_message_at*|

The last message in either direction. Null before the first message. A list puts such a conversation last.

last_inbound_at*|

The customer's last message. Null when they never wrote.

window_expires_at*|

When the 24-hour customer-service window closes. Null when it never opened.

window_open*boolean

Whether a session message (any type but template) can be sent now. Check it before a session send.

unread_count*integer

Inbound messages nobody has read in the inbox. Reading through the API does not change it.

Range0 <= value <= 9007199254740991
ai*|null
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.whatsable.app/v1/conversations/string/ai' \  -H 'Content-Type: application/json' \  -d '{  "status": "off"}'
Example Response
{  "object": "conversation",  "id": "cm2v8c1a00001qz8h4t5u6v7w",  "number_id": "cm2v8a1b20002qz8h9i0j1k2l",  "contact_id": "cm2v8k1a00001qz8h8x9y0z1a",  "last_message_at": "2026-10-20T19:51:21Z",  "last_inbound_at": "2026-10-20T18:00:00Z",  "window_expires_at": "2026-10-21T18:00:00Z",  "window_open": true,  "unread_count": 2,  "ai": {    "bot_id": "cm2v8b1a00001qz8h3j4k5l6m",    "status": "active"  },  "created_at": "2026-09-01T12:00:00Z",  "updated_at": "2026-10-20T19:51:21Z"}

Choose the bot a number answers with PUT

Sets the default AI bot of a number. It answers every conversation on the number that has no bot of its own. An `archived` bot cannot be assigned.

Switch the AI's follow-ups to a contact off or on PATCH

`off` stops the AI's follow-ups to this person on every number, and the bot keeps answering when they write. Sending `off` again is safe. `on` lets follow-ups start again from the next outbound message. It needs a key that may use every number the contact has a conversation on, or it answers `403 number_not_allowed_for_key`.