WhatsApp Business API
See https://developers.facebook.com/docs/whatsapp
Communication#openapi#messaging
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
See https://developers.facebook.com/docs/whatsapp
Endpoints 55
Users
- POSTCreate-User
/users - POSTLogin-User
/users/login - POSTLogout-User
/users/logout - GETGet-User
/users/:UserUsername - PUTUpdate-User
/users/:UserUsername - DELETEDelete-User
/users/:UserUsername
Application
- POSTSet-Shards
/account/shards - GETGet-Application-Settings
/settings/application - DELETEReset-Application-Settings
/settings/application - PATCHUpdate-Application-Settings
/settings/applicationIf a field is not present in the request, no change is made to that setting. For example, if on_call_pager is not sent with the request, the existing… - GETGet-Media-Providers
/settings/application/media/providers - POSTUpdate-Media-Providers
/settings/application/media/providers - DELETEDelete-Media-Providers
/settings/application/media/providers/:ProviderName
Backup/Restore
- POSTBackup-Settings
/settings/backup - POSTRestore-Settings
/settings/restore
Business Profile
- GETGet-Business-Profile
/settings/business/profile - POSTUpdate-Business-Profile
/settings/business/profile
Profile
- GETGet-Profile-About
/settings/profile/about - PATCHUpdate-Profile-About
/settings/profile/about - GETGet-Profile-Photo
/settings/profile/photo?format=link - POSTUpdate-Profile-Photo
/settings/profile/photo
Two-Step Verification
- POSTEnable-Two-Step
/settings/account/two-step - DELETEDisable-Two-Step
/settings/account/two-step
Registration
- POSTRequest-Code
/account - POSTRegister-Account
/account/verify
Contacts
- POSTCheck-Contact
/contacts
Messages
- POSTSend-Message
/messages - PUTMark-Message-As-Read
/messages/:MessageID
Groups
- GETGet-All-Groups
/groups - POSTCreate-Group
/groups - GETGet-Group-Info
/groups/:GroupId - PUTUpdate-Group-Info
/groups/:GroupId - DELETEDemote-Group-Admin
/groups/:GroupId/admins - PATCHPromote-To-Group-Admin
/groups/:GroupId/admins - GETGet-Group-Icon-Binary
/groups/:GroupId/icon - POSTSet-Group-Icon
/groups/:GroupId/icon - DELETEDelete-Group-Icon
/groups/:GroupId/icon - GETGet-Group-Invite
/groups/:GroupId/invite - DELETEDelete-Group-Invite
/groups/:GroupId/invite - POSTLeave-Group
/groups/:GroupId/leave - DELETERemove-Group-Participant
/groups/:GroupId/participants
Media
- POSTUpload-Media
/media - GETDownload-Media
/media/:MediaId - DELETEDelete-Media
/media/:MediaId
Health
- GETCheck-Health
/health - GETGet-Metrics (since v2.21.3)
/metrics?format=prometheus - GETGet-App-Stats
/stats/app?format=prometheus - GETGet-DB-Stats
/stats/db?format=prometheus - GETGet-Support-Info
/support
Certificates
- POSTUpload-Certificate
/certificates/external - GETDownload-CA-Certificate
/certificates/external/ca - GETDownload Webhook CA Certificate
/certificates/webhooks/ca - POSTUpload Webhook CA Certificate
/certificates/webhooks/ca - DELETEDelete Webhook CA Certificate
/certificates/webhooks/ca
- DELETEDelete-Profile-Photo
/settings/profile/photo
API details
- Base URL
http://whatsapp.localhttp://example.com/v1- Authentication
- A bearer token in the Authorization header
HTTP Basic authentication (username and password) - Operations
- 55 operations on 36 pathsPOST 20GET 18DELETE 11PUT 3PATCH 3
- Main resources
- Groups 13Application 7Users 6Certificates 5Health 5Profile 4Media 3Backup/Restore 2Business Profile 2Messages 2
- Response formats
application/jsontext/plainimage/jpeg- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the WhatsApp Business API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the WhatsApp Business API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create-User” (POST /users), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the WhatsApp Business API?
See https://developers.facebook.com/docs/whatsapp It is listed under Communication and has 55 endpoints.
Who publishes the WhatsApp Business API?
It is listed from Meta's public API description (an OpenAPI document), not published by Meta on Swastik Codes. Anyone who controls facebook.com can claim the profile by adding a DNS TXT record.
What is the base URL of the WhatsApp Business API?
Its description lists 2 base URLs: http://whatsapp.local, http://example.com/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the WhatsApp Business API?
It accepts 2 methods: A bearer token in the Authorization header; HTTP Basic authentication (username and password).
How many endpoints does the WhatsApp Business API have?
55 operations on 36 paths (20 POST, 18 GET, 11 DELETE, 3 PUT, 3 PATCH). The largest groups are Groups, Application, Users, Certificates.
Is forking the WhatsApp Business API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.