API Doc - Botbiz

Botbiz.io - Developer API Documentation

WhatsApp API

WhatsApp send API, add contact...

WhatsApp API : Account Connect

Connect WhatsApp Business Account

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/account/connect

Parameters

apiToken
Your API key.
String|Required
user_id
User ID of WhatsApp account owner.
Integer|Required
whatsapp_business_account_id
WhatsApp Business Account ID.
String|Required
access_token
Access Token.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/account/connect?apiToken=API-KEY&user_id=USER-ID&whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID&access_token=ACCESS-TOKEN

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Send Message

Send WhatsApp message to any mobile number.

Text vs Template Message

When a user writes you on your chat service using your business number, you can reply to them through text message within 24 hours. This is known as a customer-initiated text message or session message. A WhatsApp template message, on the other hand, uses a pre-approved template for communication and is an outbound message launched by a business. You can get in touch with a user using template messages if you accidentally don`t respond to their message within 24 hours.

API End-point : Send Message (GET/POST)

https://dash.botbiz.io/api/v1/whatsapp/send

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
message
Text message content (need URL encoded value for GET request).
String|Required
phone_number
Must start with country code and only numeric characters are allowed.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBER

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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",
  "message": "Message sent successfully."
}

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

Generate API End-point : Send Template Message (GET/POST)

https://dash.botbiz.io/api/v1/whatsapp/template/send

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
template_name
Name of the template to send.
String|Required
language_code
Language code of the template (e.g., `en_US`).
String|Required
components
JSON string of components for template variables (header, body, buttons).
JSON|Optional
phone_number
Must start with country code and only numeric characters are allowed.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/template/send?apiToken=API-KEY&template_name=TEMPLATE-NAME&language_code=LANGUAGE-CODE&components=COMPONENTS-JSON&phone_number=PHONE-NUMBER

POST Request Example

curl -X POST \
'https://dash.botbiz.io/api/v1/whatsapp/template/send' \
-d 'apiToken=API-KEY' \
-d 'template_name=TEMPLATE-NAME' \
-d 'language_code=LANGUAGE-CODE' \
-d 'components=COMPONENTS-JSON' \
-d 'phone_number=PHONE-NUMBER'

Sample Response

{
  "status": "1",
  "message": "Template message sent successfully."
}

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

WhatsApp API : Get Conversation

Retrieve conversation history for a particular subscriber.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/get/conversation

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
limit
Number of conversation messages to fetch.
Number|Required
offset
Offset for pagination.
Number|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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": "88017XXXXX-23",
      "whatsapp_bot_id": 23,
      "sender": "bot",
      "agent_name": null,
      "message_content": "{\"delay_in_reply\":0,\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":\"88017XXXX9003\",\"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": ""
    }
  ]
}

WhatsApp API : Bot Template Get

Retrieve WhatsApp Bot templates.

API End-point : Get Template (GET/POST)

https://dash.botbiz.io/api/v1/whatsapp/template/list

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/template/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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\":\"EAAHFAlhZBSyEBAIRZCsHKZA5ZAdOWMRL7AwuuCBKd3tZChAQQ1PHojPUS5k76aMVyzzxG9bYp2JQ57aLMfQBCZCpvXKac4KLDZAhejOuw1zkNCxGjvK7J5YwNmZBwTTd8Iig2YDq0vGZBoS20ipsLB4scbOOh0WmQrj7oLI9ZC5rFlsFC9mYctgQKIyJCvZBfgn5pGE1YPiBllrqwZDZD\"}",
    "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"
  }
}

WhatsApp API : Trigger Bot Flow

Trigger your bot to any mobile number.

API End-point : Trigger Bot Flow (GET/POST)

https://dash.botbiz.io/api/v1/whatsapp/trigger-bot

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
bot_flow_unique_id
Bot Flow Unique ID.
String|Required
phone_number
Must start with country code and only numeric characters are allowed.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/trigger-bot?apiToken=API-KEY&bot_flow_unique_id=BOT-FLOW-UNIQUE-ID&phone_number=PHONE-NUMBER

POST Request Example

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

Sample Response

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

WhatsApp API : Subscriber Get

Retrieve subscriber information using Chat ID (Phone Number).

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/get

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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": "8801521455XXX",
      "first_name": "Md Ronok",
      "last_name": "Ronok",
      "email": "[email protected]",
      "gender": "Male",
      "label_names": "Label1,Label2"
    }
  ]
}

WhatsApp API : Subscriber List

Retrieve a list of subscribers.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/list

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
limit
Number of subscribers to fetch.
Number|Required
offset
Offset for pagination.
Number|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1

POST Request Example

curl -X POST \
'https://dash.botbiz.io/api/v1/whatsapp/subscriber/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1'

Sample Response

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "880152145XXX",
      "first_name": "Mamuduzzaman",
      "last_name": "Ronok",
      "email": "[email protected]",
      "gender": "male",
      "label_names": "One ,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "8801518951XXX",
      "first_name": "Rahim",
      "last_name": "Karim",
      "email": null,
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}

WhatsApp API : Subscriber Create

Create a new subscriber/contact.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/create

Parameters

apiToken
Your API key.
String|Required
phoneNumberID
WhatsApp account phone number ID.
String|Required
name
Name of your subscriber.
String|Required
phoneNumber
Subscriber phone number with country code (without + sign).
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Subscriber Update

Update an existing subscriber's information.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/update

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
first_name
First name of your subscriber.
String|Optional
last_name
Last name of your subscriber.
String|Optional
gender
Gender of your subscriber.
String|Optional
label_ids
Label IDs with comma separated (e.g., 1,4,5).
String|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/update?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&first_name=FIRST-NAME&last_name=LAST-NAME&gender=GENDER&label_ids=LABEL-IDS

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Delete Subscriber

Delete a WhatsApp subscriber.

API End-point : Delete Subscriber (GET/POST)

https://dash.botbiz.io/api/v1/whatsapp/subscriber/delete

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
phone_number
Must start with country code and only numeric characters are allowed.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/delete?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Reset User Input Flow

Reset a user's input flow.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/reset/user-input-flow

Parameters

apiToken
Your API key.
String|Required
phone_number_id
WhatsApp account phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Subscriber Assign Chat to Team Member

Assign a subscriber's chat to a team member.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
team_member_id
Team Member ID.
Integer|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Subscriber Assign Custom Fields

Assign custom fields to a subscriber.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
custom_fields
Custom fields name and value in JSON format.
JSON|Required

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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."
}

WhatsApp API : Subscriber Assign Labels

Assign labels to a subscriber.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/assign-labels

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
label_ids
Label IDs with comma separated (e.g., 1,4,5).
String|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/assign-labels?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_ids=LABEL-IDS

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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 assign successfully."
}

WhatsApp API : Subscriber Remove Labels

Remove labels from a subscriber.

API End-point : POST

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/remove-labels

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
phone_number
Subscriber phone number.
String|Required
label_ids
Label IDs with comma separated (e.g., 1,4,5).
String|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/subscriber/chat/remove-labels?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_ids=LABEL-IDS

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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 remove successfully."
}

WhatsApp API : Label List

Retrieve a list of labels.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/label/list

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST Request Example

curl -X POST \
'https://dash.botbiz.io/api/v1/whatsapp/label/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'

Sample Response

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

WhatsApp API : Label Create

Create a new label.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/label/create

Parameters

apiToken
Your API key.
String|Required
phone_number_id
Your WhatsApp phone number ID.
String|Required
label_name
Label Name.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/label/create?apiToken=API-KEY&label_name=LABEL-NAME

POST Request Example

curl -X POST \
'https://dash.botbiz.io/api/v1/whatsapp/label/create' \
-d 'apiToken=API-KEY' \
-d 'label_name=LABEL-NAME'

Sample Response

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

WhatsApp API : Catalog List

Retrieve a list of catalogs.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/catalog/list

Parameters

apiToken
Your API key.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/catalog/list?apiToken=API-KEY

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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\"}"
    }
  ]
}

WhatsApp API : Catalog Order List

Retrieve a list of catalog orders.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/catalog/order/list

Parameters

apiToken
Your API key.
String|Required
whatsapp_catalog_id
Your WhatsApp catalog ID.
String|Optional

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-ID

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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": "17231046738801724816054",
      "catalog_id": "762561142206860",
      "chat_id": "8801724816XXX",
      "catalog_name": "Ez soci Chat",
      "first_name": "Md Ronok",
      "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\":\"Mamuduzzaman Ronok\",\"phone_number\":\"015XXXXXXXXX\",\"email\":\"[email protected]\",\"address\":\"pti road\"}",
      "checkout_account_email": null,
      "checkout_amount": "0",
      "checkout_timestamp": null,
      "transaction_id": "PD1723104673880172481605433FAD1",
      "paid_at": "2024-08-08 08:30:40",
      "status_changed_at": "2024-08-08 08:30:40"
    }
  ]
}

WhatsApp API : Catalog Order Status Change

Change the status of a catalog order.

API End-point : GET/POST

https://dash.botbiz.io/api/v1/whatsapp/catalog/order/status-change

Parameters

apiToken
Your API key.
String|Required
order_unique_id
Your Catalog Order ID.
String|Required
cart_status
Status value should be `Approved`, `Completed`, `Shipped`, `Delivered`, or `Refunded`.
String|Required

GET Request Example

https://dash.botbiz.io/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUS

POST Request Example

curl -X POST \
'https://dash.botbiz.io/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"
}