NEWBuild connected customer journeys with ChatBotJo APITalk to our team →
ChatBotJo
DEVELOPER RESOURCES

ChatBotJo API Documentation

Connect your products to ChatBotJo and automate account management, add-ons, WhatsApp conversations, and customer data with clear HTTP APIs.

Your API key

Use your private key in every request. Never expose it in browser code or public repositories.

Get an API key
Base URLhttps://chatbotjo.com/api/v1Send requests over HTTPS with your apiToken.
API

User API

Manage account information, users, packages, and account activity.

My Information

Read the authenticated account details.

GET
API endpoint/user/myInfo

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/myInfo

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Usage Log

Review API usage and recent account activity.

GET
API endpoint/user/usage/log

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
pageoptional

Page number for the results.

Integer

Request example

GET https://chatbotjo.com/api/v1/user/usage/log

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

User List

List users that belong to the account.

GET
API endpoint/user/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Team Member List

List team members and their account roles.

GET
API endpoint/users/team-member/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/users/team-member/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Create User

Create a new user under the current account.

POST
API endpoint/user/create

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
namerequired

Full name of the new user.

String
emailrequired

Unique email address.

String

Request example

POST https://chatbotjo.com/api/v1/user/create

{
  "apiToken": "YOUR_API_KEY",
  "name": "Example User",
  "email": "user@example.com"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Update User

Update profile details for an existing user.

POST
API endpoint/user/update

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
user_idrequired

The user ID to update.

Integer
nameoptional

New display name.

String

Request example

POST https://chatbotjo.com/api/v1/user/update

{
  "apiToken": "YOUR_API_KEY",
  "user_id": "USER_ID",
  "name": "Updated Name"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Package / Team Role List

Return available packages and team roles.

GET
API endpoint/user/package/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/package/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Module List

Return the modules enabled for the account.

GET
API endpoint/user/module/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/module/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Logout User

Invalidate the current API session.

POST
API endpoint/user/logout

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/user/logout

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Direct Login URL

Create a secure, one-time login URL for a user.

POST
API endpoint/user/get/direct-login-url

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
idrequired

User ID or email address.

String

Request example

POST https://chatbotjo.com/api/v1/user/get/direct-login-url

{
  "apiToken": "YOUR_API_KEY",
  "id": "ID"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Direct Login URL for New Users

Create a user when needed and return a one-time login URL.

POST
API endpoint/user/get/direct-login-url/only-new-users

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
emailrequired

New user email address.

Email

Request example

POST https://chatbotjo.com/api/v1/user/get/direct-login-url/only-new-users

{
  "apiToken": "YOUR_API_KEY",
  "email": "EMAIL"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Transaction List

List account transactions and billing events.

GET
API endpoint/user/transaction/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/transaction/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}
API

Addon API

Manage add-ons, assignments, and AI token balances for your workspace.

Addon List

List add-ons available to the account.

GET
API endpoint/user/addon/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/addon/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Create Addon

Create an add-on for a user account.

POST
API endpoint/user/addon/create

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
user_idrequired

The user receiving the add-on.

Integer
addon_idrequired

The add-on identifier.

Integer

Request example

POST https://chatbotjo.com/api/v1/user/addon/create

{
  "apiToken": "YOUR_API_KEY",
  "user_id": "USER_ID",
  "addon_id": "ADDON_ID"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Update Addon

Update the status or configuration of an add-on.

POST
API endpoint/user/addon/update

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
addon_idrequired

The add-on identifier.

Integer
statusoptional

Use active or inactive status.

String

Request example

POST https://chatbotjo.com/api/v1/user/addon/update

{
  "apiToken": "YOUR_API_KEY",
  "addon_id": "ADDON_ID",
  "status": "active"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Assign Addon

Assign an add-on and expiration date to a user.

POST
API endpoint/user/addon/assign

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
user_idrequired

The receiving user ID.

Integer
addon_idrequired

The add-on identifier.

String
expired_daterequired

Expiration date in YYYY-MM-DD format.

String

Request example

POST https://chatbotjo.com/api/v1/user/addon/assign

{
  "apiToken": "YOUR_API_KEY",
  "user_id": "USER_ID",
  "addon_id": "ADDON_ID",
  "expired_date": "2026-12-31"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Update Assign Addon

Update an assigned add-on purchase, expiration date, or status.

POST
API endpoint/user/addon/assign/update

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
purchase_idrequired

The assigned add-on purchase ID.

Integer

Request example

POST https://chatbotjo.com/api/v1/user/addon/assign/update

{
  "apiToken": "YOUR_API_KEY",
  "purchase_id": "PURCHASE_ID"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Update AI Token

Adjust the AI token balance for an account.

POST
API endpoint/user/addon/assign/credits

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
user_idrequired

The user ID receiving the tokens.

Integer
tokensrequired

Number of tokens to add or reset.

Integer

Request example

POST https://chatbotjo.com/api/v1/user/addon/assign/credits

{
  "apiToken": "YOUR_API_KEY",
  "user_id": "USER_ID",
  "tokens": "100000"
}

Sample response

{"status":"1","message":"Request completed successfully."}

De-assign Addon

Remove an add-on assignment from a user.

POST
API endpoint/addon/purchase/delete

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
user_idrequired

The user ID.

Integer
addon_idrequired

The add-on identifier.

Integer

Request example

POST https://chatbotjo.com/api/v1/addon/purchase/delete

{
  "apiToken": "YOUR_API_KEY",
  "user_id": "USER_ID",
  "addon_id": "ADDON_ID"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Addon Purchase List

List previous add-on purchases.

GET
API endpoint/user/addon/assign/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/user/addon/assign/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}
API

WhatsApp API

Connect WhatsApp conversations to your applications and customer workflows.

Connect Account

Connect a WhatsApp Business account.

POST
API endpoint/whatsapp/account/connect

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/account/connect

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Send Text Message

Send a WhatsApp text message to a permitted recipient.

POST
API endpoint/whatsapp/send

Parameters

apiTokenrequired

Your ChatBotJo API key.

String
phone_numberrequired

Recipient in international format.

String
messagerequired

Text message body.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/send

{
  "apiToken": "YOUR_API_KEY",
  "phone_number": "PHONE_NUMBER",
  "message": "MESSAGE"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Send Interactive Buttons

Send a session message with reply buttons.

POST
API endpoint/whatsapp/send/interactive-buttons

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/send/interactive-buttons

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Send File / Media

Send an image, video, audio file, or document.

POST
API endpoint/whatsapp/send/file

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/send/file

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Upload Media

Upload a file and receive the media details needed to send it.

POST
API endpoint/whatsapp/upload/media

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/upload/media

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Conversation

Retrieve the conversation for a subscriber.

GET
API endpoint/whatsapp/get/conversation

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/get/conversation

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

PostBack List

List the available postback actions.

GET
API endpoint/whatsapp/get/post-back-list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/get/post-back-list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Message Delivery Status

Retrieve delivery statuses for API messages.

GET
API endpoint/whatsapp/get/message-status

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/get/message-status

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Bot Template

List WhatsApp bot templates.

GET
API endpoint/whatsapp/get/template/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/get/template/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Send Broadcast Template

Send an approved broadcast template.

POST
API endpoint/whatsapp/broadcast/template/send

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/broadcast/template/send

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Bot Flow List

List configured bot flows for an account.

GET
API endpoint/whatsapp/get/bot-flow-list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/get/bot-flow-list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Trigger Bot Flow

Trigger a configured bot flow for a mobile number.

POST
API endpoint/whatsapp/trigger-bot

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/trigger-bot

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}
API

Subscriber API

Create and manage WhatsApp subscribers, conversations, labels, fields, notes, and sequences.

Subscriber

Get a subscriber using the chat ID or phone number.

GET
API endpoint/whatsapp/subscriber/get

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/subscriber/get

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Subscribers List

List subscribers for a WhatsApp account.

GET
API endpoint/whatsapp/subscriber/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/subscriber/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Create Subscriber

Create a WhatsApp subscriber or contact.

POST
API endpoint/whatsapp/subscriber/create

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/create

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Update Subscriber

Update an existing subscriber.

POST
API endpoint/whatsapp/subscriber/update

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/update

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Delete Subscriber

Delete a WhatsApp subscriber.

POST
API endpoint/whatsapp/subscriber/delete

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/delete

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Reset User Input Flow

Reset the active user-input flow for a subscriber.

POST
API endpoint/whatsapp/subscriber/reset/user-input-flow

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/reset/user-input-flow

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Assign Chat to Team Member

Assign a subscriber conversation to a team member.

POST
API endpoint/whatsapp/subscriber/chat/assign-to-team-member

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Mark Conversation Status

Update the status of a subscriber conversation.

POST
API endpoint/whatsapp/subscriber/chat/mark-conversation

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/mark-conversation

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Assign Custom Fields

Assign custom field values to a subscriber.

POST
API endpoint/whatsapp/subscriber/chat/assign-custom-fields

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Custom Fields List

List custom fields for the account.

GET
API endpoint/whatsapp/subscriber/custom-fields/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/subscriber/custom-fields/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Assign Labels

Assign labels to a subscriber.

POST
API endpoint/whatsapp/subscriber/chat/assign-labels

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/assign-labels

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Remove Labels

Remove labels from a subscriber.

POST
API endpoint/whatsapp/subscriber/chat/remove-labels

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/remove-labels

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Sequence List

List sequences for a WhatsApp account.

GET
API endpoint/whatsapp/subscriber/sequence/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/subscriber/sequence/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Assign Sequence

Assign a sequence to a subscriber.

POST
API endpoint/whatsapp/subscriber/chat/assign-sequence

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/assign-sequence

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Remove Sequence

Remove a subscriber from a sequence.

POST
API endpoint/whatsapp/subscriber/chat/remove-sequence

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/remove-sequence

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Add Notes

Add an internal note to a subscriber.

POST
API endpoint/whatsapp/subscriber/chat/add-notes

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/subscriber/chat/add-notes

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}
API

Labels, Commerce & AI

Manage labels, synchronize catalogs, review orders, and request AI responses.

Label List

List account labels.

GET
API endpoint/label/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/label/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Create Label

Create a label for organizing subscribers.

POST
API endpoint/label/create

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/label/create

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Catalog List

List connected WhatsApp catalogs.

GET
API endpoint/whatsapp/catalog/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/catalog/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Catalog Sync

Synchronize catalog products.

POST
API endpoint/whatsapp/catalog/sync

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/catalog/sync

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

Catalog Order List

List orders received from a WhatsApp catalog.

GET
API endpoint/whatsapp/catalog/order/list

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

GET https://chatbotjo.com/api/v1/whatsapp/catalog/order/list

?apiToken=YOUR_API_KEY

Sample response

{"status":"1","message":"Request completed successfully."}

Catalog Order Status Change

Update a catalog order status.

POST
API endpoint/whatsapp/catalog/order/status-change

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/whatsapp/catalog/order/status-change

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}

AI Get Response

Request an AI-generated response from ChatBotJo.

POST
API endpoint/ai/get_response

Parameters

apiTokenrequired

Your ChatBotJo API key.

String

Request example

POST https://chatbotjo.com/api/v1/ai/get_response

{
  "apiToken": "YOUR_API_KEY"
}

Sample response

{"status":"1","message":"Request completed successfully."}