Launch or Stop Bot

POST

/bots/{id}/status

Use this endpoint to launch a bot

Request

Path Params

Query Params

Body Params application/jsonRequired

Examples

Launch BotStop Bot

{
    "status": "start_launch"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Launch BotStop Bot

curl --location --request POST '/bots/1234/status?api_key=UKDZu-c68cubrIbniuE2P_nWj0p5r4IHARNrAV-I' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "start_launch"
}'

Responses

🟢200Success

application/json

Get updated bot

Body

Example

{
    "id": 2792787,
    "name": "My new bot",
    "token": "110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw that",
    "created_at": "2025-10-25T10:14:49.880Z",
    "updated_at": "2025-10-25T10:14:50.181Z",
    "csv_url": "string",
    "last_run_at": null,
    "status_code": null,
    "farm_id": 123,
    "store_bot_id": 123,
    "whatsapp_token": "String",
    "git_remote": "string",
    "rsa_public_key": "string",
    "whatsapp_api_url": "stringll",
    "google_analytics_ua_key": null,
    "is_protected": false,
    "cloud_id": 123,
    "production_mode": null,
    "data_volume": null,
    "dead_at": null,
    "pic_url": null,
    "invalid_token_at": null,
    "status": "works"
}

Edit Bot

Start CSV import