The Business Management API allows you to create and manage WhatsApp-related business assets, such as WhatsApp Business Accounts and message templates. The API is built on the Marketing API and leverages some of its endpoints, so this documentation may contain links to the Marketing API documentation where appropriate.
System users can be used to generate System User Access Tokens, which are typically what you will be using in API requests. Most endpoints check if the user identified by the token has access to the queried resource. If the user does not have access to the resource, the request will be rejected with error code 200
.
If your app will be accessing WhatsApp Business Accounts and assets shared with your business, we recommend creating an admin system user. If your app will only be accessing data owned by your business, either type is sufficient.
To create a system user:
By default, admin system users have full access to all WhatsApp Business Accounts and assets owned by, or shared with, the Meta business.
Admin system users are useful if your app needs to access WhatsApp Business Accounts that are newly shared with your business; if you are using an employee system user, you must manually grant access to each WhatsApp Business Account that has been shared with you.
Note that you can override an admin system user's default access by granting partial access on a per-WhatsApp Business Account basis.
Employee system users must be granted access to individual WhatsApp Business Accounts that are owned by, or shared with, the Meta business. If your app will only need access to a few WhatsApp Business Accounts that you own, an employee system user should be sufficient.
Once created, you must grant full or partial access to each WhatsApp Business Account that the system user needs to access.
We recommend that you use system user access tokens to access the Business Management API and Cloud API. To generate a System User access token after creating a system user:
Include your token in an authorization request header, preceded by Bearer
. For example:
curl -L 'https://graph.facebook.com/v18.0
/102290129340398/' \
-H 'Authorization: Bearer EAAJB...'
Although user access tokens are supported, we recommend that you use system user access tokens to access the Business Management API and Cloud API unless you are implementing Facebook Login.
Many endpoints require the user whose token is included in API requests to also be granted partial or full access to the WhatsApp Business Account being queried (or its assets). If the user does not have access, the API will return error code 200.
Granular access can be set for any user, including system users. Granular access for system users can be useful if you want to restrict access to certain assets for groups of people. For example, if you have a large business and want a certain department to only have read access to a WhatsApp Business Account's template and business phone number data, you could create a system user for that department and set granular access to view only.
To designated user access on a WhatsApp Business Account or its assets:
We recommend using our Postman collection or cURL when testing endpoints. Although you can use the Graph API Explorer tool, it passes tokens as query string parameters, which we advise against (pass tokens in request headers instead).
To get information about a business, send a GET
request to the WhatsAppBusinessAccount
endpoint where <WHATSAPP_BUSINESS_ACCOUNT_ID>
is your WhatsApp Business Account ID.
curl -i -X GET 'https://graph.facebook.com/v18.0
/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
{ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>", "name": "Your WhatsApp Business Account Name", "timezone_id": "1", "message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f" }
To get specific information about a business, such as name, message templates and phone numbers, send a GET
request to the WhatsAppBusinessAccount
endpoint where <WHATSAPP_BUSINESS_ACCOUNT_ID>
is your WhatsApp Business Account ID and set the fields
parameter to a list of items you would like returned.
curl -i -X GET 'https://graph.facebook.com/v18.0
/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
{ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>", "name": "Your WhatsApp Business Account Name", "message_templates": { "data": [ { "name": "hello_world", "components": [ { "type": "HEADER", "format": "TEXT", "text": "Hello World" }, { "type": "BODY", "text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us." }, { "type": "FOOTER", "text": "WhatsApp Business Team" } ], "language": "en_US", "status": "APPROVED", "category": "ACCOUNT_UPDATE", "id": "307191531401674" }, { "name": "sample_flight_confirmation", "components": [ { "type": "HEADER", "format": "DOCUMENT" }, { "type": "BODY", "text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}." }, { "type": "FOOTER", "text": "Este mensaje proviene de un negocio no verificado." } ], "language": "es", "status": "APPROVED", "category": "TICKET_UPDATE", }, ...
Type of Call | Endpoint |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Type of Call | Endpoint |
---|---|
|
|
|
|
|
|
|
|