BotSailor API Documentation

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/myInfo' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status": "1", "message": { "user_id": 114, "user_type": "Member", "name": "Member", "email": "member@gmail.com", "mobile": "3555757", "package_name": "Premium1", "expired_date": "2025-07-02 00:00:00", "created_at": "2022-03-26 10:55:29", "status": "1", "last_login_at": "2024-07-24 11:59:58", "last_login_ip": "127.0.0.1", "agent_has_ppu": "0", "agent_ppu_remaining": -1, "bot_subscriber_data": { "limit": "5000", "count": "1" }, "message_credit_data": { "limit": "unlimited", "used": 0 }, "whatsapp_bots_details": [ { "display_phone_number": "+91 97031 XXXX", "phone_number_id": "11906XXXXX40020", "whatsapp_business_account_id": "10039XXXX785XX", "whatsapp_business_name": "BotSailor" }] }}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/usage/log' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status": "1", "message": { "modules": [ { "module_name": "End-user", "limit": 500, "used": 1 }, { "module_name": "Connect Account", "limit": 0, "used": 0 }, { "module_name": "Message Credit", "limit": 1458, "used": 0 }, { "module_name": "Subscribers", "limit": 0, "used": 0 }, { "module_name": "Bot Message Insight", "limit": 0, "used": 0 }, { "module_name": "Bot Conditional Reply", "limit": 0, "used": 0 }, { "module_name": "Bot AI Token", "limit": 0, "used": 0 }, { "module_name": "Input Flow Campaign", "limit": 0, "used": 0 }, { "module_name": "Live Chat", "limit": 0, "used": 0 }, { "module_name": "Live Chat - Advanced", "limit": 0, "used": 0 }, { "module_name": "Live Chat - Translator", "limit": 0, "used": 0 }, { "module_name": "Sequence Campaign", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - Flows", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - eCommerce Catalog", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - Webhook Workflow", "limit": 0, "used": 0 }, { "module_name": "Webchat Bot", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - WordPress/Shopify Integration", "limit": 0, "used": 0 }, { "module_name": "Team Member", "limit": 0, "used": 0 }, { "module_name": "API Developer", "limit": 0, "used": 0 }, { "module_name": "Live Chat Restriction", "limit": 0, "used": 0 } ], "package_name": "Premium1", "total_modules": 20 }}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/list' \ 
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL' \
-d 'limit=1000' \
-d 'offset=1' 

Sample Response(All list)

{"status":"1","message":[{"user_id":114,"name":"Member","email":"member@gmail.com","mobile":"017XXXXXXXX","package_name":"Premium2","expired_date":"2023-08-05 00:00:00","created_at":"2022-03-26 10:55:29","last_login_at":"2023-08-06 08:55:13","last_login_ip":"127.0.0.1"}],"nextOffset":2}

Sample Response(Single User)

{"status": "1", "message": { "user_id": 114, "user_type": "Member", "name": "Member", "email": "member@gmail.com", "mobile": "3555757","package_id":1, "package_name": "Premium1", "expired_date": "2025-07-02 00:00:00", "created_at": "2022-03-26 10:55:29", "status": "1", "last_login_at": "2024-07-24 11:59:58", "last_login_ip": "127.0.0.1", "agent_has_ppu": "0", "agent_ppu_remaining": -1, "bot_subscriber_data": { "limit": "5000", "count": "1" }, "message_credit_data": { "limit": "unlimited", "used": 0 }, "whatsapp_bots_details": [ { "display_phone_number": "+91 97031 XXXX", "phone_number_id": "11906XXXXX40020", "whatsapp_business_account_id": "10039XXXX785XX", "whatsapp_business_name": "BotSailor" }] }}

Sample Response (Not found)

{"status":"0","message":"No user found"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/team-member/list' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status":"1","message":[{"id":205,"name":"Support Agent","email":"support@example.com","role_id":7490,"role":"Sales Agent","status":"1"},{"id":206,"name":"Sales Agent","email":"sales@example.com","role_id":7491,"role":"Support Agent","status":"0"}]}

Sample Response (Not found)

{"status":"0","message":"No team member found"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/create' \ 
-d 'apiToken=API-KEY' \
-d 'name=NAME' \
-d 'email=EMAIL' \
-d 'mobile=MOBILE' \
-d 'password=PASSWORD' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' 

Sample Response

{"status":"1","mesasge":"User Created Successfully.","id":192}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/update' \ 
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL' \
-d 'name=NAME' \
-d 'email=EMAIL' \
-d 'mobile=MOBILE' \
-d 'password=PASSWORD' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS' \
-d 'reset_monthly_usage=RESET-MONTHLY-USAGE' \
-d 'reset_ai_token_usage=0' 

Sample Response

{"status":"1","message":"User Updated Successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/package/list' \ 
-d 'apiToken=API-KEY' \
-d 'package_type=' 

Sample Response

{"status":"1","message":[{"id":1,"package_name":"Basic","package_type":"subscription","price":"Trial","validity":730,"module_ids":"1,19,18,9,10,11","monthly_limit":"{\"1\":\"1\",\"19\":\"3000\"}","visible":"1"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/module/list' \ 
-d 'apiToken=API-KEY' 

Sample Response(All list)

{"status":"1","message":{"id":1,"module_name":"Connect Account","extra_text":"","limit_enabled":"1","status":"1"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/list' \ 
-d 'apiToken=API-KEY' 

Sample Response(All list)

{"status":"1","message":{"id":2,"addon_name":"Unlimited Team Member","addon_description":"Description of addon","addon_type":"recurring","price":25,"validity":30,"product_data":"{\"fastspring\":{\"product_id\":\"\",\"coupon\":\"\"},\"paypro\":{\"product_id\":\"101357\",\"coupon\":\"ADDONDEFAULT\"},\"paypal\":{\"plan_id\":\"\"},\"razorpay\":{\"plan_id\":\"\"}}","variation_data":null,"discount_data":"{\"percent\":\"\",\"terms\":\"\",\"start_date\":\"\",\"end_date\":\"2024-11-24 13:35:12\",\"timezone\":\"Asia\\/Dhaka\",\"status\":\"1\"}","visible":"1"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/update' \ 
-d 'apiToken=API-KEY' \
-d 'id=ADDON-ID' \
-d 'addon_name=NAME' \
-d 'addon_description=DESCRIPTION' \
-d 'price=PRICE' \
-d 'validity=VALIDITY' \
-d 'validity_type=D' \
-d 'addon_type=one-time' \
-d 'extend_value=extend_value' \
-d 'visible=1' \
-d 'variation_name=["variation_name1","variation_name2"]' \
-d 'variation_validity=["30","60"]' \
-d 'variation_validity_type=["D","M"]' \
-d 'variation_extend_value=["extend_value1","extend_value2"]' \
-d 'variation_price=["price1","price2"]' 

Sample Response(All list)

{"status":"1","message":"Addon has been saved successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/assign' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'addon_id=ADDON-ID' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS' 

Sample Response(All list)

{"status":"1","message":"Addon has been assign successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/assign/list' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'limit=50' \
-d 'offset=1' 

Sample Response(All list)

{"status":"1","message":[{"id":122,"user_id":248,"seller_user_id":109,"purchase_date":"2025-05-24 06:14:04","addon_id":17,"expired_date":"2025-06-23 00:00:00","subscription_enabled":"0","subscription_data":null,"paypal_subscriber_id":"","paypal_next_check_time":null,"paypal_processing":"0","access_data":null,"last_payment_method":"Stripe","comment":null,"status":"1","updated_at":"2025-05-24 06:14:04","name":"sagor","email":"jondoe@gmail.com","addon_name":"Ai Addon"}],"nextOffset":2}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/assign/update' \ 
-d 'apiToken=API-KEY' \
-d 'id=ID' \
-d 'addon_id=5-1' \
-d 'expired_date=2025-12-31' \
-d 'status=1' 

Sample Response (Success)

{"status":"1","message":"Addon purchase updated successfully."}

Sample Response (Error)

{"status":"0","message":"Addon purchase not found."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/addon/assign/credits' \ 
-d 'apiToken=API-KEY' \
-d 'id=ID' \
-d 'used=78000' \
-d 'available=122000' \
-d 'user_id=USER_ID' 

Sample Response (Success)

{"status":"1","message":"AI tokens have been updated successfully.","used":78000,"available":122000,"credit_limit":200000}

Sample Response (Error)

{"status":"0","message":"Addon purchase not found"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/addon/purchase/delete' \ 
-d 'apiToken=API-KEY' \
-d 'id=ID' 

Sample Response (Success)

{"status":"1","message":"Addon purchase has been deleted successfully."}

Sample Response (Error)

{"status":"0","message":"Addon purchase not found"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/get/direct-login-url' \ 
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'name=NAME' \
-d 'mobile=MOBILE' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS' \
-d 'create_on_fail=1' 

Sample Response

{"status":"1","message":{"email":"user@domain.com","password":"xxxxxxxxxx","login_url":"https://botsailor.com/login","direct_login_url":"https://botsailor.com/direct-login/xxxxxxxxxx"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/get/direct-login-url/only-new-users' \ 
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'package_id=PACKAGE-ID' \
-d 'expired_date=EXPIRED-DATE' 

Sample Response (Success)

{"status":"1","message":{"email":"user@domain.com","password":"xxxxxxxxxx","login_url":"https://botsailor.com/login","direct_login_url":"https://botsailor.com/direct-login/xxxxxxxxxx"}}

Sample Response (Existing User)

{"status":"0","message":"User already existed"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/logout' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' 

Sample Response(All list)

{"status":"1","message":"User logout from the system successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/transaction/list' \ 
-d 'apiToken=API-KEY' \
-d 'limit=50' \
-d 'offset=1' 

Sample Response(All list)

{"status":"1","message":[{"id":1,"user_id":1,"buyer_user_id":249,"verify_status":"Processed","first_name":"john doe","last_name":"","buyer_email":"johndoe@gmail.com","country":"","paid_currency":"USD","paid_at":"2025-10-13 09:20:53","payment_method":"Paypal","transaction_id":"AD1760347253249","paid_amount":0,"cycle_start_date":"2025-10-13","cycle_expired_date":null,"package_id":null,"addon_id":4,"variation_index":2,"variation_data_copy":"{\"name\":\"Webchat : unlimited website\/user\",\"validity\":\"30\",\"validity_type\":\"D\",\"extend_value\":\"0\",\"price\":\"149\",\"paypro_product_id\":\"103395\",\"fastspring_product_id\":\"\",\"paypal_plan_id\":\"\",\"razorpay_plan_id\":\"\",\"status\":\"1\"}","package_name":"Monthly Package","response_source":"","paypal_txn_type":"","invoice_url":null,"subscription_unique_id":null,"email":"johndoe@gmail.com"}],"nextOffset":2}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/account/connect' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID' \
-d 'access_token=ACCESS-TOKEN' 

Sample Response

{"status":"1","message":"Whatsapp account has been connect successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/send' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'message=TEXT-MESSAGE' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1", "wa_message_id":"wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=", "message":"Message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/get/conversation' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'limit=10' \
-d 'offset=1' 

Sample Response

{"status":"1","message":[{"id":8XX3,"whatsapp_bot_subscriber_subscriber_id":"0123456789-23","whatsapp_bot_id":23,"sender":"bot","agent_name":null,"message_content":"{\"delay_in_reply\":0,\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":\"0123456789\",\"type\":\"interactive\",\"interactive\":{\"header\":{\"type\":\"text\",\"text\":\"Order gateway\"},\"body\":{\"text\":\"How would you like to purchase it?\"},\"type\":\"button\",\"action\":{\"buttons\":[{\"type\":\"reply\",\"reply\":{\"id\":\"5lvomLOuENXIe6D::gPeAiDDmVQR_jTR\",\"title\":\"Paypal pay\"}},{\"type\":\"reply\",\"reply\":{\"id\":\"YES_START_CHAT_WITH_HUMAN::CBaLoC4yTMyIljZ\",\"title\":\"COD\"}}]}}}","conversation_time":"2024-07-28 13:21:03","wa_message_id":"wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=","reaction_data":null,"message_status":null,"delivery_status_updated_at":"2024-07-28 13:21:03","failed_reason":""}],"nextOffset":101}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/get/post-back-list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' 

Sample Response

{"status":"1","message":[{"id":671,"user_id":1,"postback_id":"QUICK_REPLY_LOCATION_REPLY_BOT","whatsapp_bot_id":95,"use_status":"0","status":"1","whatsapp_bot_setting_id":1770,"bot_name":"Location quick reply","is_template":"1","template_jsoncode":"[{\"messaging_product\":\"whatsapp\",\"to\":\"replace_id\",\"type\":\"text\",\"text\":{\"body\":\"Thank you for sharing your location. It has been received. Thank you for being here with us today.\",\"preview_url\":true}}]","template_name":"Location quick reply","template_for":"location-quick-reply","template_id":null,"inherit_from_template":"0","whatsapp_bot_label_ids":"","whatsapp_bot_remove_label_ids":"","remove_sequence_campaign_id":0,"team_assign_role_id":0,"team_assign_user_id":0,"broadcast_sequence_campaign_id":0,"visual_flow_type":"flow","postback_type":"main","whatsapp_bot_visual_flow_builder_campaign_id":1358,"google_sheet_ids":"","updated_at":"2024-07-14 05:25:55","row_type":"static","custom_field_id":0,"custom_field_index":"","custom_field_index_title":"","generateGoogleMeetLink":null,"googleCalendarId":null,"googleMeetToCustomFieldId":null}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/get/message-status' \ 
-d 'apiToken=API-KEY' \
-d 'wa_message_id=WAMID.XXXXX' 

Sample Response

{"status":"1","message":{"message_status":"delivered","delivery_status_updated_at":"2024-07-28 13:21:03","read_time":null,"failed_time":null,"failed_reason":""}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/template/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' 

Sample Response

{"status":"1","message":{"id":48,"template_id":"437509121867805","whatsapp_business_id":11,"template_name":"ada","template_type":"single","locale":"en_US","header_type":"media","header_subtype":"image","header_content":"","body_content":"To send an interactive message template, make a POST call to \/PHONE_NUMBER_ID\/","footer_content":"","button_content":"[]","template_json":"{\"name\":\"template_23_1666095188\",\"language\":\"en_US\",\"category\":\"transactional\",\"components\":[{\"type\":\"header\",\"format\":\"image\",\"example\":{\"header_handle\":[\"https:\\\/\\\/example.com\\\/assets\\\/images\\\/template\\\/image.jpg\"]}},{\"type\":\"body\",\"text\":\"To send an interactive message template, make a POST call to \\\/PHONE_NUMBER_ID\\\/\"}],\"access_token\":\"[FILTERED]\"}","button_type":"none","variable_map":"{\"header\":[],\"body\":[]}","updated_at":"2022-10-18 12:13:09","user_id":1,"status":"Rejected","system_template":"0","map_needed":"0","check_wp_type":"general"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/template/status' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR-API-KEY' \
-d '{
  "phone_number_id": "104928392019283",
  "template_id": "129847192847198"
}'

GET Request Example

https://botsailor.com/api/v1/whatsapp/template/status?apiToken=YOUR-API-KEY&phone_number_id=104928392019283&template_id=129847192847198

Sample Response

{
  "status": "1",
  "message": "Template status fetched successfully.",
  "data": {
    "template_id": "129847192847198",
    "template_name": "summer_shoes_carousel",
    "status": "APPROVED",
    "category": "MARKETING",
    "language": "en_US",
    "quality_score": {
      "score": "GREEN"
    },
    "rejected_reason": null
  }
}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/get/bot-flow-list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' 

Sample Response

{"status":"1","message":[{"id":1552533,"name":"Appointment Flow","unique_id":"abc123","status":"1"},{"id":1552534,"name":"Welcome Flow","unique_id":"def456","status":"1"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/trigger-bot' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'bot_flow_unique_id=BOT-FLOW-UNIQUE-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":"Bot has been trigger successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/get' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":[{"subscriber_id":144,"chat_id":"0123456789","first_name":"john","last_name":"Doe","email":"test@gmail.com","gender":"Male","created_at":"2026-04-07 10:30:00","assigned_agent_id":12,"assigned_agent":"Support Agent","bot_reply_label":"Bot Reply On","ai_reply_label":"AI Reply On","label_names":"Label1,Label2"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=100' \
-d 'offset=1' \
-d 'orderBy=0' 

Sample Response

{"status":"1","message":[{"subscriber_id":144,"chat_id":"0123456789","first_name":"John","last_name":"Doe","email":"test@gmail.com","gender":"male","assigned_agent_id":12},{"subscriber_id":157,"chat_id":"0123456789","first_name":"john","last_name":"Doe","email":"null","gender":"Male","assigned_agent_id":12}],"nextOffset":2}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/create' \ 
-d 'apiToken=API-KEY' \
-d 'phoneNumberID=PHONE-NUMBER-ID' \
-d 'name=NAME' \
-d 'phoneNumber=MOBILE' 

Sample Response

{"status":"1","mesasge":"WhatsApp subscriber has been created."}

{"status":"0","message":"WhatsApp account not found."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

{"status":"0","message":"Something went wrong or subscriber already exist."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/update' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'first_name=FIRST-NAME' \
-d 'last_name=LAST-NAME' \
-d 'gender=GENDER' \
-d 'label_ids=LABEL-IDS' 

Sample Response

{"status":"1","message":"Subscriber Updated Successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/delete' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":"Subscriber has been deleted successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/reset/user-input-flow' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":"Reset User Input Flow successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'team_member_id=TEAM-MEMBER-ID' 

Sample Response

{"status":"1","message":"Successfully Assign Agent to Conversation."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/mark-conversation' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'action=resolved' 

Sample Response

{"status":"1","message":"Conversation marked as resolved successfully"}

action_status map

{"0":"open (reopen/unarchived/unblocked)","1":"resolved","2":"archived","3":"blocked"}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'custom_fields={"custom_filed_name1": "custom_field_value1","custom_filed_name2": "custom_field_value2"}' 

Sample Response

{"status":"1","message":"Subscriber changes have been saved successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/custom-fields/list' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status":"1","message":"Custom fields retrieved successfully","data":[{"id":1,"name":"customer_name","reply_type":"text"},{"id":2,"name":"customer_email","reply_type":"email"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-labels' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS' 

Sample Response

{"status":"1","message":"Labels have been assigned successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/remove-labels' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS' 

Sample Response

{"status":"1","message":"Labels have been assigned successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/sequence/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' 

Sample Response

{"status":"1","message":[{"id":13083,"name":"Customer Follow-up","campaign_type":"messenger","sequence_type":"default","status":"1"},{"id":13084,"name":"Abandoned Cart","campaign_type":"messenger","sequence_type":"default","status":"1"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-sequence' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS' 

Sample Response

{"status":"1","message":"Sequences have been assigned successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/remove-sequence' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS' 

Sample Response

{"status":"1","message":"Sequences have been removed successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/add-notes' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'note_text=NOTE-TEXT' 

Sample Response

{"status":"1","message":"Notes have been added successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/get-notes' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":[{"id":1,"note_text":"Customer requested callback tomorrow","noted_by_user_id":2,"noted_by_name":"Admin","updated_at":"2026-10-07 10:30:00"}]}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/crm/get' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' 

Sample Response

{"status":"1","message":{"has_deal":true,"deal_id":10,"pipeline_id":1,"pipeline_name":"Sales Pipeline","stage_id":2,"stage_name":"Qualified","stage_color":"#22c55e","stage_type":"open","title":"New Deal","value":500,"currency":"USD","expected_close_date":"2026-10-15","owner_user_id":1,"owner_name":"John Doe","lead_score":"hot","source":"WhatsApp","status":"open"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/crm/update' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'title=New Deal' \
-d 'pipeline_id=1' \
-d 'stage_id=2' \
-d 'value=500.00' \
-d 'currency=USD' \
-d 'expected_close_date=2026-10-15' \
-d 'owner_user_id=1' \
-d 'lead_score=hot' \
-d 'source=WhatsApp' 

Sample Response

{"status":"1","message":"CRM Overview updated successfully."}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/label/list' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/label/create' \ 
-d 'apiToken=API-KEY' \
-d 'label_name=LABEL-NAME' 

Sample Response

{"status":"1","message":"Label has been created successfully."}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/list' \ 
-d 'apiToken=API-KEY' 

Sample Response

{"status":true,"message":[{"catalog_id":"1429267xxxx5095","catalog_name":"The White","catalog_url":"https:xxxxx","checkout_settings":"{"tax_percentage":"5.5","shipping_charge":"20"}"}]}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/sync' \ 
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID' 

Sample Response

{"status":"1","message":"Catalog products have been synced successfully."}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/order/list' \ 
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID' 

Sample Response

{"status":"1","message":[{"order_unique_id":"172310467380123456789","catalog_id":"762561142206860","chat_id":"0123456789","catalog_name":"Catalog Name","first_name":"John","cart_total":4300,"cart_currency":"USD","cart_status_raw":"Submitted","ordered_at":"2024-08-08 08:11:13","updated_at":"2024-08-08 08:30:40","payment_amount":4300,"payment_method":"Cash on Delivery","shipping_address":"{\"name\":\"John Doe\",\"phone_number\":\"0123456789\",\"email\":\"test@gmail.com\",\"address\":\"pti road\"}","checkout_account_email":null,"checkout_amount":"0","checkout_timestamp":null,"transaction_id":"PD1723104673012345678933FAD1","paid_at":"2024-08-08 08:30:40","status_changed_at":"2024-08-08 08:30:40"}]}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/order/status-change' \ 
-d 'apiToken=API-KEY' \
-d 'order_unique_id=ORDER-UNIQUE-ID' \
-d 'cart_status=CART-STATUS' 

Sample Response

{"status":true,"message":"Cart status has been updated successfully"}
                            

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/get/direct-login-url' \ 
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'name=NAME' \
-d 'mobile=MOBILE' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS' \
-d 'create_on_fail=1' 

Sample Response

{"status":"1","message":{"email":"user@domain.com","password":"xxxxxxxxxx","login_url":"https://botsailor.com/login","direct_login_url":"https://botsailor.com/direct-login/xxxxxxxxxx"}}

POST Request Example

curl -X POST \
'https://botsailor.com/api/v1/user/get/direct-login-url/only-new-users' \ 
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'package_id=PACKAGE-ID' \
-d 'expired_date=EXPIRED-DATE' 

Sample Response (Success)

{"status":"1","message":{"email":"user@domain.com","password":"xxxxxxxxxx","login_url":"https://botsailor.com/login","direct_login_url":"https://botsailor.com/direct-login/xxxxxxxxxx"}}

Sample Response (Existing User)

{"status":"0","message":"User already existed"}