How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Route Mobile

Route Mobile WhatsApp Business API

Route Mobile is a Meta Business Solution Provider for the WhatsApp Business Platform. The API covers JWT login, account management, template and session messaging, bulk campaign upload and management, catalog and product-feed management for commerce, media ID generation, opt-in management, reporting, and client callback registration — 33 documented operations across Authentication, Account Management, Messaging, Bulk Campaigns, Catalog Management, Reports, Opt-in Management and Webhooks.

Documentation Provider Profile APIs.io OpenAPI GitHub

Route Mobile WhatsApp Business API is one of 6 APIs that Route Mobile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WhatsApp Business, Messaging, and Commerce. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 33 operations across 33 paths, organized into 8 resource areas, and defines 127 schemas. It is described by OpenAPI 3.0.0, at version 1.8.0.

Requests are made against a single base URL, https://apis.rmlconnect.net.

33 operations 33 paths 127 schemas 1 DELETE14 GET1 PATCH17 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.8.0
Base URL
https://apis.rmlconnect.net
Authentication
HTTP Bearer
Contact
Route Mobile Developer Support
License
Proprietary
Terms of Service
View terms
Resource Areas
8

Authentication & Security 1

Route Mobile WhatsApp Business API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — JSON Web Token obtained from the Login API. Include the token in the Authorization header as Bearer . Tokens expire after one hour by default.

Paths & Operations 33

Across 33 paths, the API surfaces 33 operations — 1 DELETE, 14 GET, 1 PATCH, 17 POST. They span 8 resource areas: Bulk Campaigns, Catalog Management, Reports, Opt-in Management, Webhooks, Messaging, Authentication, Account Management. Each is listed below with its method, path, parameters, and response codes.

Bulk Campaigns 2

Upload files, create, start, pause, and resume bulk messaging campaigns to reach large audiences.

POST
/wba/v2/upload
File Upload
fileUpload 2 params body → 200401404422500
POST
/wba/v2/manage_campaign
Send Bulk Campaign
sendBulkCampaign 2 params body → 202400401404422500
Catalog Management 9

Create, update, delete, and fetch product feeds and catalog details for WhatsApp Commerce.

POST
/wba/catalog/manager/v1/upload
Upload File
uploadFile body → 200400401404500
POST
/wba/catalog/manager/v1/create_product_feed
Create Product Feed
createProductFeed body → 200400401404500
POST
/wba/catalog/manager/v1/update_product_feed
Update Product Feed
updateProductFeed body → 200400401404500
POST
/wba/catalog/manager/v1/delete_product_feed
Delete product Feed
deleteProductFeed body → 200400401404500
GET
/wba/catalog/manager/v1/fetch_product_feed
Fetch Product Feed Details
fetchProductFeedDetails 3 params → 200400401404500
GET
/wba/catalog/manager/v1/fetch_product_details
Fetch All Product Feed
fetchAllProductFeed → 200401404500
GET
/wba/catalog/manager/v1/fetch_catalog_details
Fetch Catalog Details
fetchCatalogDetails 3 params → 200400401404500
GET
/wba/catalog/manager/v1/schedule_product_feed_details
Fetch Schedule Product Feed Details
fetchScheduleProductFeedDetails 1 param → 200400401404500
GET
/wba/catalog/manager/v1/fetch_errors
Fetch Errors
fetchErrors 1 param → 200400401404500
Reports 8

Generate, download, and query messaging reports including delivery stats, campaign metrics, opt-in data, and template usage counts.

POST
/whatsapp/report/v1/create_report/myaccounts_panel
Create Report
createReport body → 202400401500
POST
/whatsapp/report/v1/create_campaign_specific_report/myaccounts_panel
Create Campaign Specific Report
createCampaignSpecificReport body → 202400401404500
GET
/whatsapp/report/v1/fetch_campaign_specific_report/{report_id}
Fetch Report URL
fetchReportUrl 1 param → 202400401404500
GET
/whatsapp/report/v1/fetch_campaign_details
View Campaign Summary
viewCampaignSummary 4 params → 200401404500
GET
/whatsapp/report/v1/fetch_reports
View Report Summary
viewReportSummary 4 params → 200401404
GET
/whatsapp/report/v1/optin-download
Optin Create Report
optindownload 2 params → 200401404500
GET
/whatsapp/report/v1/summary/download_optin_report
Download Optin Report
downloadOptin 2 params → 200401404500
GET
/whatsapp/report/v1/template-count
Template Wise Count
getTemplateWiseCount 2 params → 200401404500
Opt-in Management 3

Store and verify user opt-in and opt-out consent for WhatsApp messaging compliance.

POST
/wbo/v2/optin/store
Create Optin
createOptin body → 201401404422500
POST
/wbo/v2/optinout/store
Create Optin and Optout
createOptinOut body → 201401404422500
GET
/wbo/v2/optin/check
Check Optin
checkOptin 1 param → 200401404422500
Webhooks 1

Receive real-time delivery reports, incoming messages, and interaction callbacks via your configured webhook URL.

POST
/callbacks
WhatsApp Client Callback
whatsappClientCallback body → 200
Messaging 7

Send template messages (marketing, utility, authentication) and session messages (text, media, interactive, payments, flows) to individual recipients.

GET
/wba/templates
View Template Message
viewTemplateMessage → 200400401404500
POST
/wba/template/create
Create Template
createTemplate body → 200400401404422500
POST
/wba/v1/messages
Send Template and Session Messages API
sendSessionMessageApi body → 202400401404422500
POST
/wba/templates/media-id
Get Template Media ID
media-idapis body → 200401404500
POST
/wba/media/v1/get-media-id
Generate Media ID API
media-idapi body → 200401404500
PATCH
/wba/template/update
Edit Template
editTemplate body → 200401404500
DELETE
/wba/template/
Delete Template
deleteTemplate 1 param → 200401404500
Authentication 1

Authenticate with the Route Mobile WhatsApp Business API to obtain a JWT token for subsequent API calls.

POST
/auth/v1/login/
Login API
loginApi body → 201403500
Account Management 2

Manage your WhatsApp Business profile settings, account details, and profile photo.

GET
/wba/management/v1/wbp-account-details
WBP Account Details
getAccountDetails → 200401404500
POST
/wba/management/v1/settings/profile/photo
Profile Photo API
uploadProfilePhoto 2 params body → 200401404422500

Schemas 127

The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are CampaignDetail (15 properties), LoginUserData (11 properties), BulkUploadResponse (11 properties), FetchProductFeedResponse (9 properties). Each schema is shown below with its type and property counts.

BulkUploadRequest
object
5 properties 5 required
BulkUploadResponse
object
11 properties
MessagePreview
object
A preview of the message or content associated with the campaign.
4 properties
MessagePreviewMedia
object
5 properties
MessagePreviewMediaHeader
object
1 property
MessagePreviewMediaImage
object
1 property
MessagePreviewMediaBody
object
1 property
JwtExpiredError
object
3 properties
NotFoundError
object
1 property
UnknownCampaignTypeError
object
3 properties
FileMimetypeError
object
3 properties
StartCampaignRequest
object
7 properties 7 required
ResumeCampaignRequest
object
2 properties 2 required
PauseCampaignRequest
object
2 properties 2 required
CampaignPayload
object
An object representing the template type, such as media template.
1 property 1 required
CampaignAcceptedResponse
object
2 properties
CampaignBadRequestError
object
3 properties
CampaignAuthError
object
3 properties
IncorrectPayloadTypeError
object
3 properties
IncorrectCampaignIdError
object
3 properties
CatalogUploadRequest
object
3 properties 3 required
CatalogUnauthorizedError
object
1 property
CreateProductFeedRequest
object
3 properties 2 required
FetchProductFeedResponse
object
9 properties 9 required
UpdateProductFeedRequest
object
3 properties 2 required
DeleteProductFeedRequest
object
1 property 1 required
DeleteProductFeedRequestAlt
object
1 property
CatalogAuthError
object
3 properties
CreateReportRequest
object
3 properties 3 required
ReportFilters
object
A JSON object that contains the start and end dates for the report. The format of the dates should be in YYYY-MM-DD format.
2 properties 2 required
InvalidStartDateError
object
2 properties
InvalidEndDateError
object
2 properties
CreateCampaignReportRequest
object
3 properties 3 required
CampaignReportFilters
object
An object containing the filters to apply to the report.
4 properties 4 required
CampaignDetailsResponse
object
1 property
CampaignDetail
object
15 properties
CampaignMessagePayload
object
3 properties
CampaignMessagePayloadMedia
object
3 properties
OptinStoreResponse
object
3 properties
OptinValidationError
object
3 properties
OptinValidationErrorDetail
object
1 property
CallbackIncomingText
object
4 properties
CallbackIncomingImage
object
4 properties
CallbackIncomingAudio
object
3 properties
CallbackIncomingVideo
object
3 properties
CallbackIncomingDocument
object
4 properties
CallbackIncomingLocation
object
4 properties
CallbackIncomingInteractiveList
object
4 properties
CallbackTemplateQuickReply
object
4 properties
CallbackIncomingQuickReply
object
2 properties
CallbackBusinessSingleProduct
object
4 properties
CallbackSingleProductCart
object
4 properties
CallbackMultiProductCart
object
4 properties
CallbackSentDeliveryReport
object
2 properties
CallbackReadReceipt
object
3 properties
CallbackFailedDeliveryReport
object
1 property
CreateTemplateRequest
object
5 properties
TemplateComponents
object
The message components describe the template contents and include placeholders for dynamic variables.
4 properties
TemplateComponentBody
object
WhatsApp message body.
1 property
TemplateComponentButtons
object
One-tap button usage in your WhatsApp message.
2 properties
TemplateButtonElement
object
4 properties
TemplateComponentFooter
object
Footer element.
1 property
TemplateComponentHeader
object
The header section of a template is a JSON string consisting of a set of mandatory keys that define text or multimedia messages.
2 properties
CreateTemplateCallToAction
object
5 properties
CreateTemplateQuickReply
object
5 properties
CreateTemplateMedia
object
5 properties
CreateTemplateText
object
5 properties
CreateTemplateAuthCopyCode
object
5 properties
CreateTemplateAuthAutofill
object
5 properties
CreateTemplateCatalog
object
5 properties
CreateTemplateCopyCode
object
5 properties
CreateTemplateCarousel
object
5 properties
CreateTemplateLimitedTimeOffer
object
5 properties
CreateTemplateMultiProduct
object
5 properties
CreateTemplatePaymentOrder
object
5 properties
CreateTemplateFlow
object
5 properties
SendTemplateText
object
4 properties 2 required
SendTemplateTextWithHeader
object
4 properties 2 required
SendTemplateMediaImage
object
4 properties 2 required
SendTemplateMediaDocument
object
4 properties 2 required
SendTemplateMediaVideo
object
4 properties 2 required
SendTemplateAuthCopyCode
object
2 properties 2 required
SendTemplateAuthAutofill
object
2 properties 2 required
SendTemplateQuickReply
object
4 properties 2 required
SendTemplateCarousel
object
4 properties 2 required
SendTemplateCouponCode
object
4 properties 2 required
SendTemplateCatalogThumbnail
object
4 properties 2 required
SendTemplateMultiProduct
object
4 properties 2 required
SendTemplateLimitedTimeOffer
object
4 properties 2 required
SendTemplatePayment
object
4 properties 2 required
SendTemplateFlow
object
4 properties 2 required
SendSessionText
object
4 properties 2 required
SendSessionTextReplyTo
object
5 properties 3 required
SendSessionTextPreviewUrl
object
5 properties 2 required
SendSessionDocument
object
4 properties 2 required
SendSessionAudio
object
4 properties 2 required
SendSessionImage
object
4 properties 2 required
SendSessionVideo
object
4 properties 2 required
SendSessionLocation
object
4 properties 2 required
SendSessionInteractiveList
object
4 properties 2 required
SendSessionQuickReplyMedia
object
4 properties 2 required
SendSessionQuickReplyText
object
4 properties 2 required
SendSessionSingleProduct
object
4 properties 2 required
SendSessionMultiProduct
object
4 properties 2 required
SendSessionFlow
object
7 properties 6 required
SendSessionPaymentWithCatalog
object
7 properties 6 required
SendSessionPaymentWithoutCatalog
object
6 properties 5 required
SendSessionPaymentPayU
object
7 properties 6 required
SendSessionPaymentRazorpay
object
7 properties 6 required
SendSessionPaymentUPI
object
7 properties 6 required
SendSessionPaymentLink
object
7 properties 6 required
SendSessionOrderStatus
object
5 properties 4 required
MessageAcceptedResponse
object
Every SUCCESS request sends a JSON response with the key as status, message, and requestid.
3 properties
MessageBadRequestError
object
Every failed request sends a JSON response with the key as status, message, and reason.
3 properties
MessageAuthError
object
Every failed request sends a JSON response with the key as status, message, and reason.
3 properties
MessageNotFoundError
object
1 property
LoginRequest
object
2 properties 2 required
LoginResponse
object
2 properties
LoginUserData
object
11 properties
UpdateTemplateExample
object
2 properties 2 required
UpdateTemplateLimitedTimeOffer
object
5 properties
UpdateTemplateMultiProduct
object
5 properties
UpdateTemplateAuthAutofill
object
5 properties
UpdateTemplateCatalog
object
5 properties
UpdateTemplateCopyCode
object
5 properties
UpdateTemplateCarousel
object
5 properties
ProfilePhotoRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

route-mobile-whatsapp-business.yml Raw ↑

Other APIs Route Mobile publishes across the network.

Route Mobile SMS API
AE Profile APIs.io
Route Mobile RCS Business Messaging API
AE Profile APIs.io
Route Mobile Viber Business Messages API
AE Profile APIs.io
SendClean Email API
AE Profile APIs.io
Route Mobile Enterprise Voice 2.0 API
AE Profile APIs.io
#WhatsApp Business#Messaging#Commerce
← Back to R APIs
API Details
ID
route-mobile:route-mobile-whatsapp-business-api
Base URL
https://apis.rmlconnect.net
Docs
https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp
Provider
Route Mobile
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=route-mobile-whatsapp-business-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/route-mobile-whatsapp-business-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Route Mobile WhatsApp Business API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.