API Token (apiToken)
Every request needs this. Go to API Developer Console.
Phone Number ID (phone_number_id)
Identifies which connected WhatsApp number a request acts on — required by almost every
endpoint. Go to WhatsApp → Connect Account
and look for Number ID on your bot’s card.
Business Account ID (whatsapp_business_account_id)
It’s the same card as Phone Number ID above — go to
WhatsApp → Connect Account and look
for Business Account ID, shown just under the bot’s name. This is only visible after
the WABA is already connected. If you’re connecting it for the first time via
Account Connect, you don’t have this yet — get it
from Meta instead, see
Meta Developer Account Setup.
Template ID (template_id)
Identifies a specific approved WhatsApp template, needed by
Send Template Message. Go to
Chatbot Manager → Message Template —
the ID column lists every template’s template_id.
Bot Flow and WhatsApp Bot ID (bot_flow_unique_id)
Identifies a specific Keyword Replies flow, needed by
Trigger Bot Flow. Go to
Chatbot Manager → Keyword Replies — the
Unique ID column lists each flow’s ID.
Label ID (label_id)
Identifies a label for Assign Labels and
Remove Labels. Go to
Subscriber Manager → Labels
— the ID column lists each label’s ID.
Team Member ID (team_member_id)
Identifies a team member for
Assign Chat to Team Member. Go to
Control Panel → User Manager — the User ID
column lists each member’s ID.
Sequence ID (sequence_id)
Identifies a sequence for Assign Sequence and
Remove Sequence. Go to
Chatbot Manager → Sequence — the ID
column lists each sequence’s ID.
Catalog ID and Order Unique ID (whatsapp_catalog_id, order_unique_id)
whatsapp_catalog_id identifies a connected product catalog;
order_unique_id identifies one order inside it — both used by the
Catalog API. Go to
WhatsApp → eCommerce Catalog — Catalog
Orders lists the Order Unique ID column, and the catalog filter at the top lists your
connected catalogs.
Cart Status (cart_status)
Not an ID you look up — it’s a status you set on
Catalog Order Status Change. Use one of:
| Value | Meaning |
|---|---|
Approved | Order confirmed, not yet processed. |
Completed | Order fully processed. |
Shipped | Order has left for delivery. |
Delivered | Order reached the customer. |
Refunded | Order was refunded. |
Package ID (package_id)
Identifies a subscription package — needed when creating a new user via
Get Direct Login URL. Go to
Control Panel → User Permission — the
Package ID column lists each package’s ID.
Frequently asked
Where do I get my apiToken?
Where do I get my apiToken?
API Developer Console. Treat it
like a password — never commit it to a repo.
I have template_id and id from Bot Template Get — which one do I use?
I have template_id and id from Bot Template Get — which one do I use?
Use
template_id — see the note on Bot Template Get
for why that endpoint returns two ID-looking fields.Where do I find whatsapp_bot_id vs bot_flow_unique_id?
Where do I find whatsapp_bot_id vs bot_flow_unique_id?
Both come from Chatbot Manager → Keyword Replies, in the same Unique ID column — they refer to
the same flow ID, just named differently across endpoints.
cart_status isn't showing up anywhere in the dashboard — where do I find it?
cart_status isn't showing up anywhere in the dashboard — where do I find it?
You don’t find it — you set it. It’s one of
Approved, Completed, Shipped,
Delivered, or Refunded, picked by you when calling Catalog Order Status Change.