Reference Meta Graph API - Application Connected Client Businesses | Developer Documentation Meta Graph API - Application Connected Client Businesses Copy for LLM View as Markdown Version API for retrieving connected client businesses associated with a Meta application. This endpoint allows applications to retrieve information about businesses that have established client connections through the application. This is essential for managing business relationships and understanding client business configurations. GET /{Version}/{Application-ID}/connected_client_businesses Retrieve a list of client businesses connected to the specified application. Use Cases: Monitor application-business client relationships Verify connected business configurations Retrieve business connection status and details Manage client business access and permissions Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Business connection data can be cached for moderate periods, but status information may change. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Application-IDstring·required Your Meta Application ID. This ID is provided when you create the application and can be found in your App Dashboard. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name, verification_status, business_status). Available fields: id, name, verification_status, business_status, created_time, updated_time limitinteger [min: 1, max: 100] Maximum number of connected client businesses to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to get the next page of results. beforestring Cursor for pagination. Use this to get the previous page of results. Responses Retrieve a list of client businesses connected to the specified application. Use Cases: Monitor application-business client relationships Verify connected business configurations Retrieve business connection status and details Manage client business access and permissions Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Business connection data can be cached for moderate periods, but status information may change. Implement appropriate cache invalidation strategies. 200 Successfully retrieved connected client businesses Content Type: application/json Schema: ConnectedClientBusinessesResponse Show child attributes ConnectedClientBusinessesResponse dataarray of ConnectedClientBusiness Array of connected client businesses Show child attributes data[]ConnectedClientBusiness Connected client business information and configuration Show child attributes idstring·required Unique identifier for the connected client business namestring·required Name of the connected client business verification_statusBusinessVerificationStatus Verification status of the connected client business business_statusBusinessStatus Current status of the connected client business created_timestring (date-time) Timestamp when the business connection was created updated_timestring (date-time) Timestamp when the business connection was last updated pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data afterstring Cursor pointing to the end of the page of data previousstring URL for the previous page of results nextstring URL for the next page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Application ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Management - Add Phone Numbers API | Developer Documentation WhatsApp Business Management - Add Phone Numbers API Copy for LLM View as Markdown Version API for adding phone numbers to a WhatsApp Business Account. This endpoint allows businesses to add phone numbers to their WhatsApp Business Account for messaging purposes. POST /{Version}/{Business-ID}/add_phone_numbers Add a preverified phone number to a WhatsApp Business Account. This endpoint is used by Partners to create a pool of Partner owned numbers that end clients can purchase. Use Cases: Add new phone numbers to scale messaging operations Set up phone numbers for different business locations Manage phone number inventory for business messaging Configure phone numbers for specific messaging workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Phone Number Requirements: Must be in E.164 format (e.g., +1234567890) Must not be already registered to another WhatsApp Business Account Must be capable of receiving SMS for verification Must comply with WhatsApp's business messaging policies Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your WhatsApp Business Account ID. This ID can be found in your Business Manager or through business management APIs. Required Phone number to add to the business account Content Type: application/json Schema: AddPhoneNumbersRequest Show child attributes AddPhoneNumbersRequest phone_numberstring·required Phone number to add to the business account. Accepts E.164 format or formatted numbers with spaces, hyphens, and parentheses (e.g., +1234567890, +1 (631) 555-1000, +1-631-555-1000). The phone number will be normalized and validated by the endpoint. Responses Add a preverified phone number to a WhatsApp Business Account. This endpoint is used by Partners to create a pool of Partner owned numbers that end clients can purchase. Use Cases: Add new phone numbers to scale messaging operations Set up phone numbers for different business locations Manage phone number inventory for business messaging Configure phone numbers for specific messaging workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Phone Number Requirements: Must be in E.164 format (e.g., +1234567890) Must not be already registered to another WhatsApp Business Account Must be capable of receiving SMS for verification Must comply with WhatsApp's business messaging policies 200 Phone number successfully added Content Type: application/json Schema: AddPhoneNumbersResponse Show child attributes AddPhoneNumbersResponse idstring·required Unique identifier for the preverified phone number entity that was created 400 Bad Request - Invalid parameters, malformed request, or phone number already registered Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Business Account API | Developer Documentation WhatsApp Cloud API - Business Account API Copy for LLM View as Markdown Version Retrieve Meta Business Portfolio information by Business ID. Returns business name, timezone, and other account details for managing WhatsApp Business Account configurations. Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Management API - Owned WhatsApp Business Accounts | Developer Documentation WhatsApp Business Management API - Owned WhatsApp Business Accounts Copy for LLM View as Markdown Version API for retrieving WhatsApp Business Accounts owned by a specific business. This endpoint allows businesses to retrieve comprehensive information about their owned WhatsApp Business Accounts, including account details, status, and configuration. GET /{Version}/{Business-ID}/owned_whatsapp_business_accounts Retrieve WhatsApp Business Accounts owned by the specified business. This endpoint provides comprehensive information about all WABAs owned by the business, including account details, configuration, and status information. Use Cases: Retrieve all WhatsApp Business Accounts owned by a business Filter accounts by business type Find specific accounts by ID Monitor business portfolio of WhatsApp Business Accounts Manage account access and permissions across multiple WABAs Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Account information can be cached for short periods, but status and configuration may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your Business ID. This ID represents the business portfolio that owns the WhatsApp Business Accounts and can be found in your Business Manager settings. Query Parameters business_typearray of WhatsAppBusinessType Filter accounts by business type. Can specify multiple types as comma-separated values. Use this to filter between enterprise and small-medium business accounts. afterstring Cursor for forward pagination. Use the cursor from the previous response to get the next page of results. firstinteger [min: 1, max: 100] Number of results to return in forward pagination. Maximum value is 100. Use with 'after' cursor for forward pagination. beforestring Cursor for backward pagination. Use the cursor from the previous response to get the previous page of results. lastinteger [min: 1, max: 100] Number of results to return in backward pagination. Maximum value is 100. Use with 'before' cursor for backward pagination. findstring Find a specific WhatsApp Business Account by ID within the owned accounts. Use this to quickly locate a specific account. Responses Retrieve WhatsApp Business Accounts owned by the specified business. This endpoint provides comprehensive information about all WABAs owned by the business, including account details, configuration, and status information. Use Cases: Retrieve all WhatsApp Business Accounts owned by a business Filter accounts by business type Find specific accounts by ID Monitor business portfolio of WhatsApp Business Accounts Manage account access and permissions across multiple WABAs Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Account information can be cached for short periods, but status and configuration may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved owned WhatsApp Business Accounts Content Type: application/json Schema: WhatsAppBusinessAccountsConnection Show child attributes WhatsAppBusinessAccountsConnection dataarray of WhatsAppBusinessAccount·required Array of owned WhatsApp Business Account records Show child attributes data[]WhatsAppBusinessAccount WhatsApp Business Account owned by the business Show child attributes idstring·required Unique identifier for the WhatsApp Business Account namestring·required Human-readable name of the WhatsApp Business Account message_template_namespacestring·required Namespace identifier for message templates associated with this account timezone_idstring·required Timezone identifier for the WhatsApp Business Account pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring URL for the next page of results previousstring URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Accounts API | Developer Documentation WhatsApp Business Accounts API Copy for LLM View as Markdown Version API for managing WhatsApp Business Accounts under a business portfolio. This endpoint allows businesses to retrieve and create WhatsApp Business Accounts (WABAs) for messaging and business communication purposes. WABAs can be associated with the specified business portfolio and configured with the provided parameters. GET /{Version}/{Business-ID}/whatsapp_business_accounts Retrieve a list of WhatsApp Business Accounts owned by the specified business portfolio. This endpoint provides information about WhatsApp Business Accounts that are owned by the business, including their configuration, status, and core properties. This corresponds to the GraphBusinessWhatsAppBusinessAccountsEdge functionality. Use Cases: Retrieve list of owned WhatsApp Business Accounts Monitor WABA status and configuration Verify WABA details for business integrations Manage business WhatsApp messaging setups Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: WABA information can be cached for moderate periods, but status information may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your business portfolio ID. This ID can be found in the Meta Business Suite or through business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name, currency, timezone_id). Available fields: id, name, account_review_status, purchase_order_number, currency, timezone_id, business_verification_status, country, on_behalf_of_business_info, is_enabled_for_insights, message_template_namespace business_typearray of One of "ENTERPRISE", "SMB" Filter results by WhatsApp Business Account type limitinteger [min: 1, max: 100] Maximum number of WhatsApp Business Accounts to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to get the next page of results. beforestring Cursor for pagination. Use this to get the previous page of results. findstring Find a specific WhatsApp Business Account by ID Responses Retrieve a list of WhatsApp Business Accounts owned by the specified business portfolio. This endpoint provides information about WhatsApp Business Accounts that are owned by the business, including their configuration, status, and core properties. This corresponds to the GraphBusinessWhatsAppBusinessAccountsEdge functionality. Use Cases: Retrieve list of owned WhatsApp Business Accounts Monitor WABA status and configuration Verify WABA details for business integrations Manage business WhatsApp messaging setups Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: WABA information can be cached for moderate periods, but status information may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Business Accounts Content Type: application/json Schema: WhatsAppBusinessAccountsResponse Show child attributes WhatsAppBusinessAccountsResponse dataarray of WhatsAppBusinessAccount Array of WhatsApp Business Accounts Show child attributes data[]WhatsAppBusinessAccount WhatsApp Business Account details and configuration Show child attributes idstring·required Unique identifier for the WhatsApp Business Account namestring·required Human-readable name of the WhatsApp Business Account account_review_statusAccountReviewStatus Review status of the WhatsApp Business Account purchase_order_numberstring Purchase order number associated with the account currencystring Currency code for the WABA (ISO 4217 format) timezone_idstring Timezone identifier for the WABA business_verification_statusBusinessVerificationStatus Verification status of the business associated with the WABA countrystring Country code where the WABA is registered on_behalf_of_business_infoOnBehalfOfBusinessInfo Information about the business on whose behalf the WABA operates Show child attributes idstring Business ID namestring Business name is_enabled_for_insightsboolean Whether insights are enabled for this WABA message_template_namespacestring Namespace for message templates pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data afterstring Cursor pointing to the end of the page of data previousstring URL for the previous page of results nextstring URL for the next page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{Business-ID}/whatsapp_business_accounts Create a new WhatsApp Business Account under the specified business portfolio. This endpoint creates a new WABA with the provided configuration and associates it with the business portfolio. The account will be set up with the specified payment method and business settings. Rate Limiting: Standard Graph API rate limits apply. Account creation may have additional rate limits to prevent abuse. Business Logic: Account name must be unique within the business portfolio Payment method must be valid and active Business must have appropriate permissions for WABA creation Created account will be in pending state until verification is complete Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your business portfolio ID. This ID can be found in the Meta Business Suite or through business management APIs. Required Content Type: application/json Schema: WhatsAppBusinessAccountCreationRequest Show child attributes WhatsAppBusinessAccountCreationRequest namestring·required Human-readable name for the WhatsApp Business Account primary_funding_idstring ID of the primary funding source (credit card or extended credit) purchase_order_numberstring Purchase order number for billing reference currencystring Currency code for billing (ISO 4217 format) timezone_idinteger Timezone ID for the account business_typeWhatsAppBusinessType Type of WhatsApp Business Account on_behalf_of_business_idstring Business ID when creating account on behalf of another business Responses Create a new WhatsApp Business Account under the specified business portfolio. This endpoint creates a new WABA with the provided configuration and associates it with the business portfolio. The account will be set up with the specified payment method and business settings. Rate Limiting: Standard Graph API rate limits apply. Account creation may have additional rate limits to prevent abuse. Business Logic: Account name must be unique within the business portfolio Payment method must be valid and active Business must have appropriate permissions for WABA creation Created account will be in pending state until verification is complete 200 Successfully created WhatsApp Business Account Content Type: application/json Schema: WhatsAppBusinessAccountCreationResponse Show child attributes WhatsAppBusinessAccountCreationResponse idstring·required Unique identifier for the created WhatsApp Business Account payment_account_idstring·required ID of the associated payment account for billing 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Partner Onboarding to MM Lite API | Developer Documentation WhatsApp Business Partner Onboarding to MM Lite APICopy for LLMView as MarkdownVersionAPI for onboarding partners to WhatsApp Business MM Lite partnerships.This endpoint enables solution partners to initiate MM Lite onboarding requests to end businesses.The API validates eligibility, creates business agreement requests, and automatically configuresOBO (On Behalf Of) WABA mobility intents for eligible WhatsApp Business Accounts.Core Functionality:Validates partner business and application ownershipChecks end business eligibility for MM Lite partnershipsIdentifies eligible shared WABAs and OBO WABAs associated with the partnershipAutomatically sets mobility intents on eligible OBO WABAs (BSPs only)Creates a business agreement request with MM_LITE_ONBOARDING typeReturns a unique request ID for tracking the onboarding process WhatsApp Business Pre-Verified Phone Numbers API | Developer Documentation WhatsApp Business Pre-Verified Phone Numbers API Copy for LLM View as Markdown Version API for retrieving pre-verified phone numbers associated with a WhatsApp Business Account. This endpoint allows businesses to retrieve information about pre-verified phone numbers that are available for use with their WhatsApp Business Account. GET /{Version}/{Business-ID}/preverified_numbers Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations. Use Cases: Retrieve available pre-verified phone numbers for business messaging setup Check verification status and availability of phone numbers Monitor pre-verified phone number inventory Validate phone number options before WhatsApp Business Account configuration Facilitate quick business messaging setup with pre-verified numbers Filtering and Pagination: Results can be filtered by verification status, availability, and country Cursor-based pagination is supported for large result sets Default page size is 25 items, maximum is 100 items per page Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number information can be cached for short periods, but availability status may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your Business ID for which to retrieve pre-verified phone numbers. This ID can be found in your Meta Business Manager or through business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, display_phone_number, verification_status). Available fields: id, display_phone_number, country_prefix, verification_status, availability_status, created_time, last_updated, supported_features, country_code, region limitinteger [min: 1, max: 100] Maximum number of phone numbers to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to retrieve the next page of results. This value is provided in the 'paging' object of previous responses. beforestring Cursor for pagination. Use this to retrieve the previous page of results. This value is provided in the 'paging' object of previous responses. verification_statusPhoneNumberVerificationStatus Filter results by verification status. Only phone numbers with the specified verification status will be returned. availability_statusPhoneNumberAvailabilityStatus Filter results by availability status. Only phone numbers with the specified availability status will be returned. country_codestring Filter results by country code. Only phone numbers from the specified country will be returned. Use ISO 3166-1 alpha-2 country codes. Responses Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations. Use Cases: Retrieve available pre-verified phone numbers for business messaging setup Check verification status and availability of phone numbers Monitor pre-verified phone number inventory Validate phone number options before WhatsApp Business Account configuration Facilitate quick business messaging setup with pre-verified numbers Filtering and Pagination: Results can be filtered by verification status, availability, and country Cursor-based pagination is supported for large result sets Default page size is 25 items, maximum is 100 items per page Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number information can be cached for short periods, but availability status may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved pre-verified phone numbers Content Type: application/json Schema: PreVerifiedPhoneNumbersResponse Show child attributes PreVerifiedPhoneNumbersResponse dataarray of PreVerifiedPhoneNumber·required List of pre-verified phone numbers Show child attributes data[]PreVerifiedPhoneNumber Pre-verified phone number details and status information Show child attributes idstring·required Unique identifier for the pre-verified phone number display_phone_numberstring·required Formatted display version of the phone number country_prefixinteger [min: 1, max: 999] Country code prefix for the phone number verification_statusPhoneNumberVerificationStatus·required Current verification status of the pre-verified phone number availability_statusPhoneNumberAvailabilityStatus Current availability status of the pre-verified phone number created_timestring (date-time) Timestamp when the phone number was pre-verified last_updatedstring (date-time) Timestamp when the phone number information was last updated supported_featuresarray of WhatsAppBusinessFeature List of WhatsApp Business features supported by this phone number Show child attributes supported_features[]WhatsAppBusinessFeature WhatsApp Business features supported by the phone number country_codestring ISO 3166-1 alpha-2 country code for the phone number regionstring Geographic region or area for the phone number pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Pre-Verified Phone Numbers API | Developer Documentation WhatsApp Business Pre-Verified Phone Numbers API Copy for LLM View as Markdown Version API for retrieving pre-verified phone numbers associated with a WhatsApp Business Account. This endpoint allows businesses to retrieve information about pre-verified phone numbers that are available for use with their WhatsApp Business Account. GET /{Version}/{Business-ID}/preverified_numbers Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations. Use Cases: Retrieve available pre-verified phone numbers for business messaging setup Check verification status and availability of phone numbers Monitor pre-verified phone number inventory Validate phone number options before WhatsApp Business Account configuration Facilitate quick business messaging setup with pre-verified numbers Filtering and Pagination: Results can be filtered by verification status, availability, and country Cursor-based pagination is supported for large result sets Default page size is 25 items, maximum is 100 items per page Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number information can be cached for short periods, but availability status may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Business-IDstring·required Your Business ID for which to retrieve pre-verified phone numbers. This ID can be found in your Meta Business Manager or through business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, display_phone_number, verification_status). Available fields: id, display_phone_number, country_prefix, verification_status, availability_status, created_time, last_updated, supported_features, country_code, region limitinteger [min: 1, max: 100] Maximum number of phone numbers to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to retrieve the next page of results. This value is provided in the 'paging' object of previous responses. beforestring Cursor for pagination. Use this to retrieve the previous page of results. This value is provided in the 'paging' object of previous responses. verification_statusPhoneNumberVerificationStatus Filter results by verification status. Only phone numbers with the specified verification status will be returned. availability_statusPhoneNumberAvailabilityStatus Filter results by availability status. Only phone numbers with the specified availability status will be returned. country_codestring Filter results by country code. Only phone numbers from the specified country will be returned. Use ISO 3166-1 alpha-2 country codes. Responses Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations. Use Cases: Retrieve available pre-verified phone numbers for business messaging setup Check verification status and availability of phone numbers Monitor pre-verified phone number inventory Validate phone number options before WhatsApp Business Account configuration Facilitate quick business messaging setup with pre-verified numbers Filtering and Pagination: Results can be filtered by verification status, availability, and country Cursor-based pagination is supported for large result sets Default page size is 25 items, maximum is 100 items per page Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number information can be cached for short periods, but availability status may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved pre-verified phone numbers Content Type: application/json Schema: PreVerifiedPhoneNumbersResponse Show child attributes PreVerifiedPhoneNumbersResponse dataarray of PreVerifiedPhoneNumber·required List of pre-verified phone numbers Show child attributes data[]PreVerifiedPhoneNumber Pre-verified phone number details and status information Show child attributes idstring·required Unique identifier for the pre-verified phone number display_phone_numberstring·required Formatted display version of the phone number country_prefixinteger [min: 1, max: 999] Country code prefix for the phone number verification_statusPhoneNumberVerificationStatus·required Current verification status of the pre-verified phone number availability_statusPhoneNumberAvailabilityStatus Current availability status of the pre-verified phone number created_timestring (date-time) Timestamp when the phone number was pre-verified last_updatedstring (date-time) Timestamp when the phone number information was last updated supported_featuresarray of WhatsAppBusinessFeature List of WhatsApp Business features supported by this phone number Show child attributes supported_features[]WhatsAppBusinessFeature WhatsApp Business features supported by the phone number country_codestring ISO 3166-1 alpha-2 country code for the phone number regionstring Geographic region or area for the phone number pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Business does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Cloud API - Groups Invite Link API | Developer Documentation WhatsApp Business Cloud API - Groups Invite Link API Copy for LLM View as Markdown Version The Groups API gives you simple functions to control groups through their lifecycle. When you create a new group, an invite link is created for inviting participants to the group. Since you cannot manually add participants to the group, simply send a message with your invite link to WhatsApp users who you would like to join the group. Select language Select status code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Cloud API - Groups Join Requests API | Developer Documentation WhatsApp Business Cloud API - Groups Join Requests API Copy for LLM View as Markdown Version The Groups API gives you simple functions to control groups through their lifecycle. When you create a new group, an invite link is created for inviting participants to the group. Since you cannot manually add participants to the group, simply send a message with your invite link to WhatsApp users who you would like to join the group. Select language POST /{Version}/{group_id}/join_requests Approve one or more join requests Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required group_idstring·required Group ID Required Content Type: application/json Schema: object Show child attributes messaging_product"whatsapp"·required join_requestsarray of string·required Array of join request IDs to approve Show child attributes join_requests[]string Join request ID Responses Approve one or more join requests 200 Join requests approval response Content Type: application/json Schema: object Show child attributes messaging_productstring approved_join_requestsarray of string Show child attributes approved_join_requests[]string ID of approved join request failed_join_requestsarray of object Show child attributes failed_join_requests[]object Show child attributes join_request_idstring errorsarray of Error Show child attributes errors[]Error Show child attributes codeinteger Error code messagestring Error message titlestring Error title error_dataobject Show child attributes detailsstring Error details errorsarray of Error Show child attributes errors[]Error Show child attributes codeinteger Error code messagestring Error message titlestring Error title error_dataobject Show child attributes detailsstring Error details Select language Select status code DELETE /{Version}/{group_id}/join_requests Reject one or more join requests Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required group_idstring·required Group ID Required Content Type: application/json Schema: object Show child attributes messaging_product"whatsapp"·required join_requestsarray of string·required Array of join request IDs to reject Show child attributes join_requests[]string Join request ID Responses Reject one or more join requests 200 Join requests rejection response Content Type: application/json Schema: object Show child attributes messaging_productstring rejected_join_requestsarray of string Show child attributes rejected_join_requests[]string ID of rejected join request failed_join_requestsarray of object Show child attributes failed_join_requests[]object Show child attributes join_request_idstring errorsarray of Error Show child attributes errors[]Error Show child attributes codeinteger Error code messagestring Error message titlestring Error title error_dataobject Show child attributes detailsstring Error details errorsarray of Error Show child attributes errors[]Error Show child attributes codeinteger Error code messagestring Error message titlestring Error title error_dataobject Show child attributes detailsstring Error details Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Cloud API - Groups Participants API | Developer Documentation WhatsApp Business Cloud API - Groups Participants API Copy for LLM View as Markdown Version The Groups API gives you simple functions to control groups through their lifecycle. When you create a new group, an invite link is created for inviting participants to the group. Since you cannot manually add participants to the group, simply send a message with your invite link to WhatsApp users who you would like to join the group. Select language Select language Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Cloud API - Groups Query API | Developer Documentation WhatsApp Business Cloud API - Groups Query API Copy for LLM View as Markdown Version The Groups API gives you simple functions to control groups through their lifecycle. When you create a new group, an invite link is created for inviting participants to the group. Since you cannot manually add participants to the group, simply send a message with your invite link to WhatsApp users who you would like to join the group. Select language Select language Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Media API | Developer Documentation WhatsApp Cloud API - Media API Copy for LLM View as Markdown Version Retrieve and delete uploaded media files by media ID. Get media URLs with file metadata including size, MIME type, and SHA256 hash. Media URLs are valid for 5 minutes after retrieval. Select language Select status code DELETE /{Version}/{Media-ID} To delete media, make a DELETE call to the ID of the media you want to delete. Prerequisites User Access Token with whatsapp_business_messaging permission Media object ID from either uploading media endpoint or media message Webhooks Responses To delete media, make a DELETE call to the ID of the media you want to delete. Prerequisites User Access Token with whatsapp_business_messaging permission Media object ID from either uploading media endpoint or media message Webhooks 200 Delete Media Content Type: application/json Schema: object Show child attributes successboolean Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Media Download API | Developer Documentation WhatsApp Cloud API - Media Download API Copy for LLM View as Markdown Version Download media files using URLs obtained from media retrieval endpoints. Returns binary media content with appropriate MIME type headers. Media URLs expire after 5 minutes and must be re-retrieved if expired. Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Message History Events API | Developer Documentation WhatsApp Business Message History Events API Copy for LLM View as Markdown Version API for retrieving WhatsApp Business Message History Events and delivery status occurrences. This endpoint allows businesses to retrieve detailed message delivery status events for specific message history entries, including delivery status transitions, timestamps, and application information. GET /{Version}/{Message-History-ID}/events Retrieve paginated message delivery status events for a specific message history entry, including delivery status occurrences, timestamps, and application information. Use Cases: Track detailed message delivery status events and transitions Monitor delivery status occurrence timestamps Retrieve application information for delivery events Debug message delivery issues and status changes Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Message history events can be cached for short periods, but delivery status events may change frequently. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination. Use the after and before cursors from the response to navigate through results. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Message-History-IDstring·required Your WhatsApp Business Message History ID. This ID is provided when you retrieve message history and can be found through message history APIs. Query Parameters status_filterWhatsAppMessageDeliveryStatus Filter results by specific delivery status. When provided, only events with this delivery status will be returned. fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (cursor, node{id,delivery_status,occurrence_timestamp}). Available fields: cursor, node{id,delivery_status,error_description,occurrence_timestamp,status_timestamp,application} limitinteger [min: 1, max: 100] Maximum number of message history events to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to get the next page of results. This value comes from the paging.cursors.after field in previous responses. beforestring Cursor for pagination. Use this to get the previous page of results. This value comes from the paging.cursors.before field in previous responses. Responses Retrieve paginated message delivery status events for a specific message history entry, including delivery status occurrences, timestamps, and application information. Use Cases: Track detailed message delivery status events and transitions Monitor delivery status occurrence timestamps Retrieve application information for delivery events Debug message delivery issues and status changes Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Message history events can be cached for short periods, but delivery status events may change frequently. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination. Use the after and before cursors from the response to navigate through results. 200 Successfully retrieved WhatsApp message history events Content Type: application/json Schema: MessageHistoryEventsResponse Show child attributes MessageHistoryEventsResponse dataarray of WhatsAppMessageHistoryEventsEdge Array of message history event edges Show child attributes data[]WhatsAppMessageHistoryEventsEdge Edge containing message delivery status occurrence with pagination cursor Show child attributes cursorstring Pagination cursor for this edge nodeWhatsAppBusinessMessageDeliveryStatusOccurrence·required Message delivery status occurrence with detailed event information Show child attributes idstring·required Unique identifier for the message delivery status occurrence delivery_statusWhatsAppMessageDeliveryStatus·required Message delivery status error_descriptionstring Error description if the delivery encountered an error occurrence_timestampinteger (int64)·required Unix timestamp when the delivery status occurrence happened status_timestampinteger (int64) Unix timestamp when the status was recorded applicationApplicationNode Meta application that processed the delivery status event Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application pagingPaginationInfo Pagination information for navigating through results Show child attributes cursorsobject Pagination cursors for navigation Show child attributes beforestring Cursor for the previous page of results afterstring Cursor for the next page of results previousstring (uri) URL for the previous page of results nextstring (uri) URL for the next page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Message History ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business - Assigned WhatsApp Business Accounts API | Developer Documentation WhatsApp Business - Assigned WhatsApp Business Accounts API Copy for LLM View as Markdown Version API for retrieving WhatsApp Business Accounts that have been assigned to a specific user. This endpoint allows apps to retrieve WhatsApp Business Accounts that are assigned to specific users. GET /{Version}/{User-ID}/assigned_whatsapp_business_accounts Retrieve WhatsApp Business Accounts that have been assigned to a specific user. This endpoint provides information about account assignments, permissions, and current status corresponding to the GraphAssignedWhatsAppBusinessAccountsEdge node. Use Cases: Retrieve all WhatsApp Business Accounts assigned to a user Check user permissions for specific accounts Monitor account assignment status and changes Validate user access before performing business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Assignment information can be cached for short periods, but permissions and status may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. User-IDstring·required The user ID for whom to retrieve assigned WhatsApp Business Accounts. This must be a valid user ID within your solution or partnership. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name, status). Available fields: id, name, status, assignment_date, permissions, business_id, phone_numbers limitinteger [min: 1, max: 100] Maximum number of accounts to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to get the next page of results. beforestring Cursor for pagination. Use this to get the previous page of results. Responses Retrieve WhatsApp Business Accounts that have been assigned to a specific user. This endpoint provides information about account assignments, permissions, and current status corresponding to the GraphAssignedWhatsAppBusinessAccountsEdge node. Use Cases: Retrieve all WhatsApp Business Accounts assigned to a user Check user permissions for specific accounts Monitor account assignment status and changes Validate user access before performing business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Assignment information can be cached for short periods, but permissions and status may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved assigned WhatsApp Business Accounts Content Type: application/json Schema: AssignedAccountsResponse Show child attributes AssignedAccountsResponse dataarray of AssignedWhatsAppBusinessAccount·required List of assigned WhatsApp Business Accounts Show child attributes data[]AssignedWhatsAppBusinessAccount WhatsApp Business Account assigned to a user Show child attributes idstring·required Unique identifier for the WhatsApp Business Account namestring·required Display name of the WhatsApp Business Account statusWhatsAppBusinessAccountStatus·required Current status of the WhatsApp Business Account assignment_datestring (date-time) Date and time when the account was assigned to the user permissionsarray of WhatsAppBusinessAccountPermission List of permissions granted to the user for this account Show child attributes permissions[]WhatsAppBusinessAccountPermission Permission level for WhatsApp Business Account access business_idstring Business ID that owns this WhatsApp Business Account phone_numbersarray of PhoneNumberInfo Phone numbers associated with this WhatsApp Business Account Show child attributes phone_numbers[]PhoneNumberInfo Phone number information for WhatsApp Business Account Show child attributes idstring Phone number ID display_phone_numberstring Formatted phone number for display verified_namestring Verified business name for this phone number statusOne of "CONNECTED", "DISCONNECTED", "MIGRATED", "PENDING", "DELETED" Status of the phone number pagingPagingInfo Pagination information for the response Show child attributes cursorsobject Show child attributes beforestring Cursor for the previous page afterstring Cursor for the next page nextstring URL for the next page of results previousstring URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - User ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Incoming Webhook Payload | Developer Documentation WhatsApp Incoming Webhook Payload Copy for LLM View as Markdown Version Schemas for incoming WhatsApp webhook notifications. Defines payload structures for messages, status updates, and user interactions sent from WhatsApp users to businesses via webhooks. POST /whatsapp/webhooks Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types. Request Syntax Select language Required Content Type: application/json Schema: WebhookPayload Show child attributes WebhookPayload objectstring·required Always 'whatsapp_business_account' for these webhooks. entryarray of Entry·required Show child attributes entry[]Entry Show child attributes idstring·required WhatsApp Business Account ID. changesarray of Change·required Show child attributes changes[]Change Show child attributes valueMust be one of: IncomingMessageValueGeneral, IncomingMessageValueSystem, StatusMessageValue, GroupValue·required Show child attributes IncomingMessageValueGeneral Show child attributes messaging_productstring·required Always 'whatsapp'. metadataMetadata·required Show child attributes display_phone_numberstring·required Business display phone number. phone_number_idstring·required Business phone number ID. contactsarray of ContactProfile·required Array of contact profiles for the sender. Included for all non-system incoming messages. Show child attributes contacts[]ContactProfile Show child attributes profileobject·required Show child attributes namestring·required WhatsApp user's name as it appears in their profile in the WhatsApp client. wa_idstring WhatsApp user ID. Note that a WhatsApp user's ID and phone number may not always match. messagesarray of IncomingMessage·required Array of message objects. The structure varies based on the 'type' property. Show child attributes messages[]IncomingMessage Show child attributes TextMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"text"·required textobject·required Show child attributes bodystring·required Text body of the message. contextobject Only included if message via a "Message business" button. Show child attributes fromstring·required Business display phone number. idstring·required WhatsApp message ID of the message the user used to access the "Message business" button. referred_productobject·required Show child attributes catalog_idstring·required Product catalog ID. product_retailer_idstring·required Product ID. referralobject Only included if message via a Click to WhatsApp ad. Show child attributes source_urlstring·required Ad URL. source_idstring·required Ad ID. source_typeOne of "ad", "post"·required bodystring·required Ad primary text. headlinestring·required Ad headline. media_typeOne of "image", "video"·required image_urlstring Only included for image media_type. video_urlstring Only included for video media_type. thumbnail_urlstring Only included for video media_type. ctwa_clidstring·required Ad click ID. welcome_messageobject Show child attributes textstring·required Ad greeting text. ReactionMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"reaction"·required reactionobject·required Show child attributes message_idstring·required WhatsApp message ID of the message the WhatsApp user reacted to. emojistring·required Emoji sent by the WhatsApp user as a reaction. AudioMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"audio"·required audioobject Show child attributes mime_typestring·required Media asset MIME type. sha256string·required Media asset SHA-256 hash. idstring·required Media asset ID. A GET request on this ID can provide the asset URL. voiceboolean·required Boolean indicating if audio is a recording made with the WhatsApp client voice recording feature (true) or not (false). DocumentMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"document"·required documentobject Show child attributes mime_typestring·required Media asset MIME type. sha256string·required Media asset SHA-256 hash. idstring·required Media asset ID. A GET request on this ID can provide the asset URL. filenamestring·required Media asset filename. ImageMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"image"·required imageobject Show child attributes mime_typestring·required Media asset MIME type. sha256string·required Media asset SHA-256 hash. idstring·required Media asset ID. A GET request on this ID can provide the asset URL. captionstring Media asset caption text. StickerMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"sticker"·required stickerobject Show child attributes mime_typestring·required Media asset MIME type. sha256string·required Media asset SHA-256 hash. idstring·required Media asset ID. A GET request on this ID can provide the asset URL. animatedboolean·required Boolean indicating if the sticker is animated (true) or not (false). VideoMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"video"·required videoobject Show child attributes mime_typestring·required Media asset MIME type. sha256string·required Media asset SHA-256 hash. idstring·required Media asset ID. A GET request on this ID can provide the asset URL. captionstring Media asset caption text. LocationMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"location"·required locationobject·required Show child attributes addressstring·required Location address. latitudenumber (float)·required Location latitude. longitudenumber (float)·required Location longitude. namestring·required Location name. urlstring Location URL. Usually only included for business locations. ContactSharingMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"contacts"·required contactsarray of ContactObject·required Array of contact objects. Many contact object properties may be omitted if the WhatsApp user chooses not to share them, or their device prevents them from being shared. Show child attributes contacts[]object Show child attributes addressesarray of object Show child attributes addresses[]object Show child attributes citystring City mentioned in the contact address countrystring Country mentioned in the contact address Show child attributes country_codestring ISO country code for the contact address statestring State mentioned in the contact address streetstring Street mentioned in the contact address typestring Type of address, such as home or work zipstring Zip code in the contact address birthdaystring (date) Contact birthday (YYYY-MM-DD). emailsarray of object Show child attributes emails[]object Show child attributes emailstring (email) Email address of the contact typestring Type of email, such as personal or work nameobject Show child attributes formatted_namestring·required Contact's formatted name first_namestring Contact’s first name last_namestring Contact’s last name middle_namestring Contact’s middle name suffixstring Contact’s name suffix prefixstring Contact’s name prefix orgobject Show child attributes companystring Name of the company where the contact works departmentstring Name of the department where the contact works titlestring Contact's job title phonesarray of object Show child attributes phones[]object Show child attributes phonestring Contact’s Phone number wa_idstring Contact's WhatsApp Number. Note that a WhatsApp user's ID and phone number may not always match. typestring Type of phone number. For example, cell, mobile, main, iPhone, home, work, etc. urlsarray of object Show child attributes urls[]object Show child attributes urlstring (uri) Website URL associated with the contact or their company typestring Type of website. For example, company, work, personal, Facebook Page, Instagram, etc. UnsupportedMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. typeOne of "unsupported", "unknown"·required contextobject·required Show child attributes fromstring·required Business display phone number. idstring·required WhatsApp message ID of the message containing the button the WhatsApp user tapped. buttonobject·required Show child attributes payloadstring·required Quick-reply button payload. textstring·required Quick-reply button label text. ButtonMessage InteractiveMessageReply Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"interactive"·required contextobject·required Show child attributes fromstring·required Business display phone number. idstring·required WhatsApp message ID of the message containing the interactive component the user tapped. interactiveobject·required Show child attributes typeOne of "list_reply", "button_reply"·required Type of interactive reply (list_reply or button_reply). OrderMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"order"·required orderobject·required Show child attributes catalog_idstring·required Product catalog ID. textstring·required Empty string. product_itemsarray of object·required Show child attributes product_items[]object Show child attributes product_retailer_idstring·required Product ID. quantityinteger·required Product quantity. item_pricenumber (float)·required Individual product price. currencystring·required Catalog currency code. IncomingMessageValueSystem Show child attributes messaging_productstring·required Always 'whatsapp'. metadataMetadata·required Show child attributes display_phone_numberstring·required Business display phone number. phone_number_idstring·required Business phone number ID. messagesarray of SystemMessage·required Array containing only 'system' message objects. Show child attributes messages[]SystemMessage Show child attributes fromstring·required WhatsApp user phone number. Note that a WhatsApp user's phone number and ID may not always match. idstring·required Unique WhatsApp message ID. timestampstring·required Unix timestamp indicating when the webhook was triggered. type"system"·required systemobject·required Show child attributes bodystring·required Description of the system change (e.g., user changed number). wa_idstring New WhatsApp user ID. type"user_changed_number"·required Type of system message. notunknown StatusMessageValue Show child attributes messaging_productstring·required Always 'whatsapp'. metadataMetadata·required Show child attributes display_phone_numberstring·required Business display phone number. phone_number_idstring·required Business phone number ID. statusesarray of Statuses·required Array of status objects. Show child attributes statuses[]Statuses Show child attributes idstring·required Unique WhatsApp message ID the status is associated with. statusOne of "sent", "delivered", "read", "failed"·required timestampstring·required recipient_idstring·required Recipeint phone number. group_idstring Group ID if the message was sent to a group. conversationConversation Show child attributes idstring expiration_timestampstring originConversationOrigin Show child attributes typestring pricingPricing Show child attributes billableboolean pricing_modelOne of "CBP", "PMP" categorystring errorsarray of StatusError Show child attributes errors[]StatusError Show child attributes codeinteger titlestring messagestring error_dataErrorData Show child attributes detailsstring hrefstring GroupValue Show child attributes messaging_productstring·required Always 'whatsapp'. metadataMetadata·required Show child attributes display_phone_numberstring·required Business display phone number. phone_number_idstring·required Business phone number ID. groupsarray of Groups·required Array of group objects. Show child attributes groups[]Groups Show child attributes timestampinteger·required Unix timestamp of the group event group_idstring·required Unique identifier for the group typeOne of "group_create", "group_delete", "group_settings_update", "group_add_participants", "group_remove_participants"·required Type of group event request_idstring·required Unique identifier for the request subjectstring Group subject/name descriptionstring Group description added_participantsarray of GroupParticipant List of participants added to the group Show child attributes added_participants[]GroupParticipant Show child attributes inputstring Input phone number or WhatsApp ID wa_idstring WhatsApp ID of the participant removed_participantsarray of GroupParticipant List of participants removed from the group Show child attributes removed_participants[]GroupParticipant Show child attributes inputstring Input phone number or WhatsApp ID wa_idstring WhatsApp ID of the participant profile_pictureGroupProfilePicture Show child attributes mime_typestring MIME type of the profile picture sha256string SHA256 hash of the profile picture fieldOne of "messages", "group_lifecycle_update", "group_settings_update", "group_participant_update"·required The field indicate to what object is the webhook related: messages: the webhook is related to messages from consumer or status of message sent by business to consumer. group_lifecycle_update: the webhook is related to group creation and deletion. group_settings_update: the webhook is related to group settings update. group_participant_update: the webhook is related to participants joining and leaving the groups. Responses Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types. 200 Webhook received successfully Select language Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business API - WhatsApp Account Number API | Developer Documentation WhatsApp Business API - WhatsApp Account Number API Copy for LLM View as Markdown Version API for retrieving WhatsApp Account Number details and configuration information. This endpoint allows businesses to retrieve comprehensive information about their WhatsApp Account Numbers, including status, verification details, and configuration settings. GET /{Version}/{WhatsApp-Account-Number-ID} Retrieve comprehensive details about a WhatsApp Account Number, including its current status, verification information, quality rating, and configuration settings. Use Cases: Monitor account number status and quality rating Verify account number configuration before messaging operations Check verification and approval status Retrieve display name and business profile information Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Account number details can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Account-Number-IDstring·required Your WhatsApp Account Number ID. This ID represents the account number entity and can be obtained from your WhatsApp Business Account phone numbers list. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, display_phone_number, status). Available fields: id, display_phone_number, verified_name, status, quality_rating, country_code, country_dial_code, code_verification_status, name_status, messaging_limit_tier, account_mode, certificate, is_official_business_account Responses Retrieve comprehensive details about a WhatsApp Account Number, including its current status, verification information, quality rating, and configuration settings. Use Cases: Monitor account number status and quality rating Verify account number configuration before messaging operations Check verification and approval status Retrieve display name and business profile information Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Account number details can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Account Number details Content Type: application/json Schema: WhatsAppAccountNumber Show child attributes WhatsAppAccountNumber idstring·required Unique identifier for the WhatsApp Account Number display_phone_numberstring·required Phone number in international format for display purposes verified_namestring Business name verified for this phone number statusWhatsAppAccountNumberStatus·required Current status of the WhatsApp Account Number quality_ratingWhatsAppPhoneNumberQualityRating Quality rating based on message delivery and user feedback country_codestring ISO 3166-1 alpha-2 country code country_dial_codestring Country dialing code code_verification_statusWhatsAppCodeVerificationStatus Two-step verification status for the phone number name_statusWhatsAppDisplayNameStatus Status of the display name associated with the phone number messaging_limit_tierOne of "TIER_50", "TIER_250", "TIER_1K", "TIER_10K", "TIER_100K", "TIER_UNLIMITED" Current messaging limit tier for the account number account_modeWhatsAppBusinessSandboxEligibility Account mode indicating sandbox or live environment certificatestring Business certificate information for the account number is_official_business_accountboolean Whether this is an official business account 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Account Number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account - Assigned Users Management API | Developer Documentation WhatsApp Business Account - Assigned Users Management API Copy for LLM View as Markdown Version API for managing user assignments and permissions for WhatsApp Business Accounts. This endpoint allows businesses to manage user access to their WhatsApp Business Accounts, including listing assigned users, adding users with specific permissions, and removing user access. GET /{Version}/{WhatsApp-Business-Account-ID}/assigned_users Retrieve a list of users assigned to the WhatsApp Business Account with their permissions and user details. This endpoint supports pagination and filtering capabilities. Use Cases: Audit user access to WhatsApp Business Account Retrieve user permission assignments for compliance List all users with access for management purposes Monitor user access patterns and assignments Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: User assignment data can be cached for short periods, but permission changes may occur frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Business-Account-IDstring·required Your WhatsApp Business Account ID. This ID is provided when you create the account and can be found in your Business Manager or through account management APIs. Query Parameters businessstring·required Business ID that owns or has access to the WhatsApp Business Account. This parameter is required to specify the business context for user assignments. fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, business, user_type limitinteger [min: 1, max: 100] Maximum number of assigned users to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use this to get the next page of results. beforestring Cursor for pagination. Use this to get the previous page of results. Responses Retrieve a list of users assigned to the WhatsApp Business Account with their permissions and user details. This endpoint supports pagination and filtering capabilities. Use Cases: Audit user access to WhatsApp Business Account Retrieve user permission assignments for compliance List all users with access for management purposes Monitor user access patterns and assignments Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: User assignment data can be cached for short periods, but permission changes may occur frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved assigned users list Content Type: application/json Schema: AssignedUsersResponse Show child attributes AssignedUsersResponse dataarray of AssignedUser·required Array of assigned users Show child attributes data[]AssignedUser User assigned to WhatsApp Business Account with permissions Show child attributes idstring·required Unique identifier for the assigned user namestring·required Display name of the assigned user businessBusinessNode Business entity associated with the user Show child attributes idstring Unique identifier for the business namestring Name of the business user_typeAssignedUserType Type of user assignment pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data afterstring Cursor pointing to the end of the page of data nextstring Graph API endpoint for the next page of results previousstring Graph API endpoint for the previous page of results summaryAssignedUsersSummary Summary information about assigned users Show child attributes total_countinteger Total number of assigned users 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{WhatsApp-Business-Account-ID}/assigned_users Add a user to the WhatsApp Business Account with specified permission tasks. This operation grants the user access to perform specific actions on the account based on the provided permission tasks. Use Cases: Grant user access to WhatsApp Business Account management Assign specific permission tasks for granular access control Add new team members to WhatsApp Business Account operations Configure user permissions for different business roles Permission Tasks: Different permission tasks grant access to different WhatsApp Business Account features: MANAGE: General account management permissions DEVELOP: Development and API access permissions MANAGE_TEMPLATES: Message template management MANAGE_PHONE: Phone number management MESSAGING: Send and receive messages FULL_CONTROL: Complete access to all account features Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Business-Account-IDstring·required Your WhatsApp Business Account ID. This ID is provided when you create the account and can be found in your Business Manager or through account management APIs. Required Content Type: application/x-www-form-urlencoded Schema: object Show child attributes userstring·required User ID of the person to add to the WhatsApp Business Account. This must be a valid Facebook user ID. tasksarray of WhatsAppBusinessAccountPermissionTask·required Array of permission tasks to grant to the user. These tasks determine what actions the user can perform on the WhatsApp Business Account. Show child attributes tasks[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access Responses Add a user to the WhatsApp Business Account with specified permission tasks. This operation grants the user access to perform specific actions on the account based on the provided permission tasks. Use Cases: Grant user access to WhatsApp Business Account management Assign specific permission tasks for granular access control Add new team members to WhatsApp Business Account operations Configure user permissions for different business roles Permission Tasks: Different permission tasks grant access to different WhatsApp Business Account features: MANAGE: General account management permissions DEVELOP: Development and API access permissions MANAGE_TEMPLATES: Message template management MANAGE_PHONE: Phone number management MESSAGING: Send and receive messages FULL_CONTROL: Complete access to all account features Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. 200 Successfully added user to WhatsApp Business Account Content Type: application/json Schema: SuccessResponse Show child attributes SuccessResponse successboolean·required Indicates whether the operation was successful 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID or User ID does not exist Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code DELETE /{Version}/{WhatsApp-Business-Account-ID}/assigned_users Remove a user's access from the WhatsApp Business Account. This operation revokes all permissions and access rights for the specified user on the account. Use Cases: Revoke user access when they leave the organization Remove temporary access grants Clean up user permissions for security compliance Manage user lifecycle and access control Important Notes: This operation removes ALL permissions for the user on this WhatsApp Business Account The user will lose access to all account features and data This action cannot be undone - the user must be re-added if access is needed again Webhooks may be triggered to notify of user access changes Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Business-Account-IDstring·required Your WhatsApp Business Account ID. This ID is provided when you create the account and can be found in your Business Manager or through account management APIs. Required Content Type: application/x-www-form-urlencoded Schema: object Show child attributes userstring·required User ID of the person to remove from the WhatsApp Business Account. This must be a valid Facebook user ID that is currently assigned to the account. Responses Remove a user's access from the WhatsApp Business Account. This operation revokes all permissions and access rights for the specified user on the account. Use Cases: Revoke user access when they leave the organization Remove temporary access grants Clean up user permissions for security compliance Manage user lifecycle and access control Important Notes: This operation removes ALL permissions for the user on this WhatsApp Business Account The user will lose access to all account features and data This action cannot be undone - the user must be re-added if access is needed again Webhooks may be triggered to notify of user access changes Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. 200 Successfully removed user from WhatsApp Business Account Content Type: application/json Schema: SuccessResponse Show child attributes SuccessResponse successboolean·required Indicates whether the operation was successful 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID or User ID does not exist or is not assigned Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account - Conversational Automation API | Developer Documentation WhatsApp Business Account - Conversational Automation API Copy for LLM View as Markdown Version API for managing conversational automation settings for WhatsApp Business Account phone numbers. This endpoint allows businesses to configure automated conversation features including welcome messages, conversation prompts (ice breakers), and bot commands for their WhatsApp Business phone numbers. POST /{Version}/{Phone-Number-ID}/conversational_automation Configure conversational automation settings for a WhatsApp Business Account phone number, including welcome messages, conversation prompts (ice breakers), and bot commands. Use Cases: Set up automated welcome messages for new customer conversations Configure conversation prompts to guide customer interactions Define bot commands for common customer service scenarios Update existing automation settings Enable or disable specific automation features Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Validation: Command names must be unique within the same phone number Prompts and command descriptions must comply with WhatsApp Business policies Maximum limits are enforced for prompts and commands Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list. Required Content Type: application/json Schema: ConversationalAutomationRequest Show child attributes ConversationalAutomationRequest enable_welcome_messageboolean Whether to enable welcome messages for new conversations promptsarray of string List of conversation prompts (ice breakers) to help guide customer interactions Show child attributes prompts[]string Individual conversation prompt text commandsarray of BotCommand List of bot commands for automated responses Show child attributes commands[]BotCommand Bot command configuration for automated responses Show child attributes command_namestring·required Name of the bot command (without leading slash) command_descriptionstring·required Description of what the command does Responses Configure conversational automation settings for a WhatsApp Business Account phone number, including welcome messages, conversation prompts (ice breakers), and bot commands. Use Cases: Set up automated welcome messages for new customer conversations Configure conversation prompts to guide customer interactions Define bot commands for common customer service scenarios Update existing automation settings Enable or disable specific automation features Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Validation: Command names must be unique within the same phone number Prompts and command descriptions must comply with WhatsApp Business policies Maximum limits are enforced for prompts and commands 200 Successfully configured conversational automation settings Content Type: application/json Schema: ConversationalAutomationResponse Show child attributes ConversationalAutomationResponse successboolean·required Indicates whether the automation configuration was successful 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Extended Credits API | Developer Documentation WhatsApp Cloud API - Extended Credits API Copy for LLM View as Markdown Version Retrieve extended credit line information for WhatsApp Business Accounts. Returns credit line IDs and associated legal entity names for billing and payment management. Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business API - Phone Number Management API | Developer Documentation WhatsApp Business API - Phone Number Management API Copy for LLM View as Markdown Version API for managing WhatsApp Business Account phone numbers, including retrieving phone number details and creating new phone number registrations within a WhatsApp Business Account. GET /{Version}/{WABA-ID}/phone_numbers Retrieve all phone numbers associated with a WhatsApp Business Account, including their status, verification details, and configuration information. Use Cases: List all phone numbers in a WhatsApp Business Account Monitor phone number status and verification progress Check phone number quality ratings and messaging limits Retrieve phone number configuration details Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include account_mode, messaging_limit_tier, and is_official_business_account. Sorting: Results can be sorted by creation_time or last_onboarded_time in ascending or descending order. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number data can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through the business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned. Available fields include: id, display_phone_number, verified_name, status, quality_rating, country_code, country_dial_code, code_verification_status, unified_cert_status, account_mode, host_platform, messaging_limit_tier, is_official_business_account, username filteringstring JSON-encoded array of filter conditions. Each filter should specify field, operator, and value. Supported fields: account_mode, messaging_limit_tier, is_official_business_account sortOne of "creation_time.asc", "creation_time.desc", "last_onboarded_time.asc", "last_onboarded_time.desc" Sort field and direction. Format: field_name.asc or field_name.desc Supported fields: creation_time, last_onboarded_time limitinteger [min: 1, max: 100] Maximum number of phone numbers to return per page afterstring Cursor for pagination - retrieve records after this cursor beforestring Cursor for pagination - retrieve records before this cursor Responses Retrieve all phone numbers associated with a WhatsApp Business Account, including their status, verification details, and configuration information. Use Cases: List all phone numbers in a WhatsApp Business Account Monitor phone number status and verification progress Check phone number quality ratings and messaging limits Retrieve phone number configuration details Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include account_mode, messaging_limit_tier, and is_official_business_account. Sorting: Results can be sorted by creation_time or last_onboarded_time in ascending or descending order. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number data can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Business Account phone numbers Content Type: application/json Schema: WhatsAppBusinessAccountPhoneNumbersConnection Show child attributes WhatsAppBusinessAccountPhoneNumbersConnection dataarray of WhatsAppBusinessAccountPhoneNumber·required Array of phone number records Show child attributes data[]WhatsAppBusinessAccountPhoneNumber WhatsApp Business Account phone number details and status information Show child attributes idstring·required Unique identifier for the phone number status record display_phone_numberstring·required Phone number in international format for display purposes verified_namestring Business name verified for this phone number statusWhatsAppPhoneNumberStatus·required Current status of the phone number in the WhatsApp Business Account quality_ratingWhatsAppPhoneNumberQualityRating Quality rating for the phone number based on messaging patterns country_codestring ISO 3166-1 alpha-2 country code country_dial_codestring Country dialing code code_verification_statusWhatsAppCodeVerificationStatus Status of phone number verification code unified_cert_statusWhatsAppBusinessUnifiedCertStatus Unified certification status combining business and name verification account_modeWhatsAppBusinessSandboxEligibility Account mode indicating sandbox or live environment eligibility host_platformWhatsAppBusinessAccountHostPlatform Platform hosting the WhatsApp Business Account messaging_limit_tierOne of "TIER_50", "TIER_250", "TIER_1K", "TIER_10K", "TIER_100K", "TIER_UNLIMITED" Current messaging limit tier for the phone number is_official_business_accountboolean Whether this is an official business account usernamestring WhatsApp username for the business account (if available) pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page afterstring Cursor pointing to the end of the page previousstring URL for the previous page of results nextstring URL for the next page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{WABA-ID}/phone_numbers Create a new phone number registration within a WhatsApp Business Account. This endpoint initiates the phone number onboarding process, including verification and business name approval. Use Cases: Add new phone numbers to a WhatsApp Business Account Migrate phone numbers from on-premises to Cloud API Register pre-verified phone numbers for BSP scenarios Initiate phone number verification and business name approval process Prerequisites: WhatsApp Business Account must have available phone number slots Phone number must not be already registered with WhatsApp Business Business must meet WhatsApp Business API requirements Appropriate permissions and app review completion Process Flow: Submit phone number and business name for registration Phone number verification code will be sent (if not pre-verified) Business name will be submitted for review Monitor status through GET endpoint until approval Rate Limiting: Phone number creation is subject to strict rate limits to prevent abuse. Standard Graph API rate limits also apply. Migration Support: Set migrate_phone_number=true when migrating from on-premises API to Cloud API. Additional validation and migration-specific logic will be applied. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID where the phone number will be added. This ID can be found in your WhatsApp Manager or through business management APIs. Required Content Type: application/json Schema: PhoneNumberCreateRequest Show child attributes PhoneNumberCreateRequest phone_numberstring·required Phone number in E.164 format without the + prefix verified_namestring·required Business name to be verified for this phone number ccstring Country code for the phone number migrate_phone_numberboolean Whether this is a phone number migration from on-premises preverified_idstring Pre-verified phone number ID for BSP scenarios Responses Create a new phone number registration within a WhatsApp Business Account. This endpoint initiates the phone number onboarding process, including verification and business name approval. Use Cases: Add new phone numbers to a WhatsApp Business Account Migrate phone numbers from on-premises to Cloud API Register pre-verified phone numbers for BSP scenarios Initiate phone number verification and business name approval process Prerequisites: WhatsApp Business Account must have available phone number slots Phone number must not be already registered with WhatsApp Business Business must meet WhatsApp Business API requirements Appropriate permissions and app review completion Process Flow: Submit phone number and business name for registration Phone number verification code will be sent (if not pre-verified) Business name will be submitted for review Monitor status through GET endpoint until approval Rate Limiting: Phone number creation is subject to strict rate limits to prevent abuse. Standard Graph API rate limits also apply. Migration Support: Set migrate_phone_number=true when migrating from on-premises API to Cloud API. Additional validation and migration-specific logic will be applied. 200 Successfully created phone number registration Content Type: application/json Schema: PhoneNumberCreateResponse Show child attributes PhoneNumberCreateResponse idstring·required Unique identifier for the created phone number status record 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or phone number limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 409 Conflict - Phone number already exists or is in use Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account - Schedules API | Developer Documentation WhatsApp Business Account - Schedules API Copy for LLM View as Markdown Version API for managing WhatsApp Business Account schedules and scheduling configurations. This endpoint allows businesses to manage scheduling functionality for their WhatsApp Business Account, including retrieving existing schedules and creating new scheduling configurations for automated messaging, business hours, and other time-based operations. GET /{Version}/{WABA-ID}/schedules Retrieve all schedules associated with a WhatsApp Business Account, including their configuration, status, and execution details. Use Cases: List all schedules in a WhatsApp Business Account Monitor schedule status and performance Check schedule configuration and timing details Retrieve schedule execution history and metrics Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include status, schedule_type, and is_active. Sorting: Results can be sorted by created_time or updated_time in ascending or descending order. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Schedule data can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through the business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned. Available fields include: id, name, status, schedule_type, description, start_time, end_time, timezone, days_of_week, created_time, updated_time, is_active, recurrence_pattern filteringstring JSON-encoded array of filter conditions. Each filter should specify field, operator, and value. Supported fields: status, schedule_type, is_active sortOne of "created_time.asc", "created_time.desc", "updated_time.asc", "updated_time.desc" Sort field and direction. Format: field_name.asc or field_name.desc Supported fields: created_time, updated_time limitinteger [min: 1, max: 100] Maximum number of schedules to return per page afterstring Cursor for pagination - retrieve records after this cursor beforestring Cursor for pagination - retrieve records before this cursor Responses Retrieve all schedules associated with a WhatsApp Business Account, including their configuration, status, and execution details. Use Cases: List all schedules in a WhatsApp Business Account Monitor schedule status and performance Check schedule configuration and timing details Retrieve schedule execution history and metrics Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include status, schedule_type, and is_active. Sorting: Results can be sorted by created_time or updated_time in ascending or descending order. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Schedule data can be cached for short periods, but status information may change frequently. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Business Account schedules Content Type: application/json Schema: WhatsAppBusinessAccountSchedulesConnection Show child attributes WhatsAppBusinessAccountSchedulesConnection dataarray of WhatsAppBusinessAccountSchedule·required Array of schedule records Show child attributes data[]WhatsAppBusinessAccountSchedule WhatsApp Business Account schedule configuration and details Show child attributes idstring·required Unique identifier for the schedule namestring·required Human-readable name for the schedule statusWhatsAppScheduleStatus·required Current status of the schedule schedule_typeWhatsAppScheduleType·required Type of schedule configuration descriptionstring Optional description of the schedule purpose start_timestring (time) Schedule start time in HH:MM format end_timestring (time) Schedule end time in HH:MM format timezonestring Timezone identifier for the schedule days_of_weekarray of DayOfWeek Days of the week when the schedule is active Show child attributes days_of_week[]DayOfWeek Day of the week created_timestring (date-time) ISO 8601 timestamp when the schedule was created updated_timestring (date-time) ISO 8601 timestamp when the schedule was last updated is_activeboolean Whether the schedule is currently active recurrence_patternRecurrencePattern Pattern for recurring schedules Show child attributes frequencyOne of "DAILY", "WEEKLY", "MONTHLY", "YEARLY" intervalinteger [min: 1] Interval between recurrences end_datestring (date) End date for the recurrence pattern pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page afterstring Cursor pointing to the end of the page previousstring URL for the previous page of results nextstring URL for the next page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{WABA-ID}/schedules Create a new schedule configuration within a WhatsApp Business Account. This endpoint allows businesses to set up automated scheduling for various operations such as business hours, automated responses, and maintenance windows. Use Cases: Create business hours schedules for automated responses Set up maintenance windows for system operations Configure automated message campaigns with timing Establish recurring schedule patterns for business operations Prerequisites: WhatsApp Business Account must have scheduling feature enabled Appropriate permissions for schedule management Valid timezone and time format specifications Business must meet WhatsApp Business API requirements Process Flow: Submit schedule configuration with timing and recurrence details System validates schedule parameters and conflicts Schedule is created and activated based on is_active flag Monitor schedule status through GET endpoint Rate Limiting: Schedule creation is subject to rate limits to prevent abuse. Standard Graph API rate limits also apply. Validation: Start time must be before end time Timezone must be valid IANA timezone identifier Days of week must be valid if specified Recurrence pattern must be consistent with schedule type Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID where the schedule will be created. This ID can be found in your WhatsApp Manager or through business management APIs. Required Content Type: application/json Schema: ScheduleCreateRequest Show child attributes ScheduleCreateRequest namestring·required Human-readable name for the schedule schedule_typeWhatsAppScheduleType·required Type of schedule configuration descriptionstring Optional description of the schedule purpose start_timestring (time)·required Schedule start time in HH:MM format end_timestring (time)·required Schedule end time in HH:MM format timezonestring Timezone identifier for the schedule days_of_weekarray of DayOfWeek Days of the week when the schedule is active Show child attributes days_of_week[]DayOfWeek Day of the week is_activeboolean Whether the schedule should be active upon creation recurrence_patternRecurrencePattern Pattern for recurring schedules Show child attributes frequencyOne of "DAILY", "WEEKLY", "MONTHLY", "YEARLY" intervalinteger [min: 1] Interval between recurrences end_datestring (date) End date for the recurrence pattern Responses Create a new schedule configuration within a WhatsApp Business Account. This endpoint allows businesses to set up automated scheduling for various operations such as business hours, automated responses, and maintenance windows. Use Cases: Create business hours schedules for automated responses Set up maintenance windows for system operations Configure automated message campaigns with timing Establish recurring schedule patterns for business operations Prerequisites: WhatsApp Business Account must have scheduling feature enabled Appropriate permissions for schedule management Valid timezone and time format specifications Business must meet WhatsApp Business API requirements Process Flow: Submit schedule configuration with timing and recurrence details System validates schedule parameters and conflicts Schedule is created and activated based on is_active flag Monitor schedule status through GET endpoint Rate Limiting: Schedule creation is subject to rate limits to prevent abuse. Standard Graph API rate limits also apply. Validation: Start time must be before end time Timezone must be valid IANA timezone identifier Days of week must be valid if specified Recurrence pattern must be consistent with schedule type 200 Successfully created schedule Content Type: application/json Schema: ScheduleCreateResponse Show child attributes ScheduleCreateResponse idstring·required Unique identifier for the created schedule 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or schedule limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Account ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 409 Conflict - Schedule name already exists or time conflict Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account - Subscribed Apps API | Developer Documentation WhatsApp Business Account - Subscribed Apps API Copy for LLM View as Markdown Version API for managing app subscriptions to WhatsApp Business Account webhooks and retrieving subscription details. This endpoint allows apps to subscribe to, unsubscribe from, and query webhook subscriptions for WhatsApp Business Accounts. GET /{Version}/{WABA-ID}/subscribed_apps Retrieve a list of all applications currently subscribed to webhook events for the specified WhatsApp Business Account. Use Cases: Monitor which apps are subscribed to WABA webhook events Audit subscription configurations and permissions Verify subscription status before making changes Retrieve subscription details for troubleshooting Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Subscription data can be cached for short periods, but may change when apps subscribe or unsubscribe. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned. Available fields: id, name, link Responses Retrieve a list of all applications currently subscribed to webhook events for the specified WhatsApp Business Account. Use Cases: Monitor which apps are subscribed to WABA webhook events Audit subscription configurations and permissions Verify subscription status before making changes Retrieve subscription details for troubleshooting Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Subscription data can be cached for short periods, but may change when apps subscribe or unsubscribe. Implement appropriate cache invalidation strategies. 200 Successfully retrieved list of subscribed applications Content Type: application/json Schema: SubscribedAppsResponse Show child attributes SubscribedAppsResponse dataarray of SubscribedApp·required Array of subscribed applications Show child attributes data[]SubscribedApp Subscribed application details Show child attributes whatsapp_business_api_dataWhatsAppBusinessApiData·required Application subscription data for WhatsApp Business Account Show child attributes idstring·required Unique identifier for the subscribed application namestring·required Name of the subscribed application linkstring URL link to the application override_callback_uristring Custom webhook callback URL for this subscription 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{WABA-ID}/subscribed_apps Subscribe your application to webhook events for the specified WhatsApp Business Account. This enables your app to receive real-time notifications for events such as message deliveries, status updates, and other WABA activities. Use Cases: Enable webhook notifications for your app Configure custom callback URLs for webhook delivery Set up webhook verification tokens for security Override default app webhook settings for specific WABAs Rate Limiting: Standard Graph API rate limits apply. Subscription operations may have additional throttling to prevent abuse. Security: Always use HTTPS endpoints for webhook callbacks. Verify webhook authenticity using the provided verification tokens and signature validation. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through business management APIs. Optional Optional configuration for webhook subscription Content Type: application/json Schema: SubscriptionRequest Show child attributes SubscriptionRequest override_callback_uristring Custom webhook callback URL to override app default verify_tokenstring Verification token for webhook security Responses Subscribe your application to webhook events for the specified WhatsApp Business Account. This enables your app to receive real-time notifications for events such as message deliveries, status updates, and other WABA activities. Use Cases: Enable webhook notifications for your app Configure custom callback URLs for webhook delivery Set up webhook verification tokens for security Override default app webhook settings for specific WABAs Rate Limiting: Standard Graph API rate limits apply. Subscription operations may have additional throttling to prevent abuse. Security: Always use HTTPS endpoints for webhook callbacks. Verify webhook authenticity using the provided verification tokens and signature validation. 200 Successfully subscribed to WABA webhooks Content Type: application/json Schema: SubscriptionResponse Show child attributes SubscriptionResponse successboolean·required Indicates whether the subscription operation was successful dataarray of SubscribedApp Array containing subscription details Show child attributes data[]SubscribedApp Subscribed application details Show child attributes whatsapp_business_api_dataWhatsAppBusinessApiData·required Application subscription data for WhatsApp Business Account Show child attributes idstring·required Unique identifier for the subscribed application namestring·required Name of the subscribed application linkstring URL link to the application override_callback_uristring Custom webhook callback URL for this subscription 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code DELETE /{Version}/{WABA-ID}/subscribed_apps Unsubscribe your application from webhook events for the specified WhatsApp Business Account. This will stop your app from receiving webhook notifications for this WABA. Use Cases: Disable webhook notifications when no longer needed Clean up subscriptions during app decommissioning Temporarily disable webhooks for maintenance Remove subscriptions for WABAs no longer managed by your app Rate Limiting: Standard Graph API rate limits apply. Unsubscription operations are typically processed immediately. Important: Unsubscribing will immediately stop all webhook deliveries for this WABA. Ensure your application can handle the cessation of webhook events gracefully. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager or through business management APIs. Responses Unsubscribe your application from webhook events for the specified WhatsApp Business Account. This will stop your app from receiving webhook notifications for this WABA. Use Cases: Disable webhook notifications when no longer needed Clean up subscriptions during app decommissioning Temporarily disable webhooks for maintenance Remove subscriptions for WABAs no longer managed by your app Rate Limiting: Standard Graph API rate limits apply. Unsubscription operations are typically processed immediately. Important: Unsubscribing will immediately stop all webhook deliveries for this WABA. Ensure your application can handle the cessation of webhook events gracefully. 200 Successfully unsubscribed from WABA webhooks Content Type: application/json Schema: SubscriptionResponse Show child attributes SubscriptionResponse successboolean·required Indicates whether the subscription operation was successful dataarray of SubscribedApp Array containing subscription details Show child attributes data[]SubscribedApp Subscribed application details Show child attributes whatsapp_business_api_dataWhatsAppBusinessApiData·required Application subscription data for WhatsApp Business Account Show child attributes idstring·required Unique identifier for the subscribed application namestring·required Name of the subscribed application linkstring URL link to the application override_callback_uristring Custom webhook callback URL for this subscription 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or subscription not found Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Template API | Developer Documentation WhatsApp Cloud API - Template API Copy for LLM View as Markdown Version Create, retrieve, update, and delete message templates. Manage pre-approved message formats for business-initiated conversations. Includes template submission, localization, and quality score metrics. Select language Select status code Select language Select status code Select language Select status code Select language Select status code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account Solutions List API | Developer Documentation WhatsApp Business Account Solutions List API Copy for LLM View as Markdown Version API for retrieving Multi-Partner Solutions associated with a WhatsApp Business Account (WABA). This endpoint allows authorized applications to retrieve a list of Multi-Partner Solutions that are associated with a specific WhatsApp Business Account. GET /{Version}/{WABA-ID}/solutions Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID for which to retrieve associated Multi-Partner Solutions. This ID can be found in your WhatsApp Business Manager or through WABA management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions limitinteger [min: 1, max: 100] Maximum number of solutions to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Returns solutions after this cursor position. Use the cursor from the previous response's paging.cursors.after field. beforestring Cursor for pagination. Returns solutions before this cursor position. Use the cursor from the previous response's paging.cursors.before field. Responses Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. 200 Successfully retrieved Multi-Partner Solutions list Content Type: application/json Schema: SolutionsList Show child attributes SolutionsList dataarray of WhatsAppBusinessSolution·required Array of Multi-Partner Solutions associated with the WABA Show child attributes data[]WhatsAppBusinessSolution Multi-Partner Solution details and configuration Show child attributes idstring·required Unique identifier for the Multi-Partner Solution namestring·required Human-readable name of the Multi-Partner Solution statusWhatsAppBusinessSolutionStatus·required Current effective status of the Multi-Partner Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending solution status transition requests owner_appApplicationNode Meta application that owns the Multi-Partner Solution Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application owner_permissionsarray of WhatsAppBusinessAccountPermissionTask List of WhatsApp Business Account permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access pagingPaging Pagination information for cursor-based pagination Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned previousstring Graph API endpoint URL for the previous page of data nextstring Graph API endpoint URL for the next page of data 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account Solutions List API | Developer Documentation WhatsApp Business Account Solutions List API Copy for LLM View as Markdown Version API for retrieving Multi-Partner Solutions associated with a WhatsApp Business Account (WABA). This endpoint allows authorized applications to retrieve a list of Multi-Partner Solutions that are associated with a specific WhatsApp Business Account. GET /{Version}/{WABA-ID}/solutions Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID for which to retrieve associated Multi-Partner Solutions. This ID can be found in your WhatsApp Business Manager or through WABA management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions limitinteger [min: 1, max: 100] Maximum number of solutions to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Returns solutions after this cursor position. Use the cursor from the previous response's paging.cursors.after field. beforestring Cursor for pagination. Returns solutions before this cursor position. Use the cursor from the previous response's paging.cursors.before field. Responses Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. 200 Successfully retrieved Multi-Partner Solutions list Content Type: application/json Schema: SolutionsList Show child attributes SolutionsList dataarray of WhatsAppBusinessSolution·required Array of Multi-Partner Solutions associated with the WABA Show child attributes data[]WhatsAppBusinessSolution Multi-Partner Solution details and configuration Show child attributes idstring·required Unique identifier for the Multi-Partner Solution namestring·required Human-readable name of the Multi-Partner Solution statusWhatsAppBusinessSolutionStatus·required Current effective status of the Multi-Partner Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending solution status transition requests owner_appApplicationNode Meta application that owns the Multi-Partner Solution Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application owner_permissionsarray of WhatsAppBusinessAccountPermissionTask List of WhatsApp Business Account permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access pagingPaging Pagination information for cursor-based pagination Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned previousstring Graph API endpoint URL for the previous page of data nextstring Graph API endpoint URL for the next page of data 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account Solutions List API | Developer Documentation WhatsApp Business Account Solutions List API Copy for LLM View as Markdown Version API for retrieving Multi-Partner Solutions associated with a WhatsApp Business Account (WABA). This endpoint allows authorized applications to retrieve a list of Multi-Partner Solutions that are associated with a specific WhatsApp Business Account. GET /{Version}/{WABA-ID}/solutions Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-IDstring·required WhatsApp Business Account ID for which to retrieve associated Multi-Partner Solutions. This ID can be found in your WhatsApp Business Manager or through WABA management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions limitinteger [min: 1, max: 100] Maximum number of solutions to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Returns solutions after this cursor position. Use the cursor from the previous response's paging.cursors.after field. beforestring Cursor for pagination. Returns solutions before this cursor position. Use the cursor from the previous response's paging.cursors.before field. Responses Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: Discover available Multi-Partner Solutions for business onboarding Monitor solution status and availability across your WABA Retrieve solution ownership and permission details Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution listings can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Pagination: This endpoint supports cursor-based pagination using limit, after, and before parameters. Use the paging object in responses to navigate through result sets. 200 Successfully retrieved Multi-Partner Solutions list Content Type: application/json Schema: SolutionsList Show child attributes SolutionsList dataarray of WhatsAppBusinessSolution·required Array of Multi-Partner Solutions associated with the WABA Show child attributes data[]WhatsAppBusinessSolution Multi-Partner Solution details and configuration Show child attributes idstring·required Unique identifier for the Multi-Partner Solution namestring·required Human-readable name of the Multi-Partner Solution statusWhatsAppBusinessSolutionStatus·required Current effective status of the Multi-Partner Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending solution status transition requests owner_appApplicationNode Meta application that owns the Multi-Partner Solution Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application owner_permissionsarray of WhatsAppBusinessAccountPermissionTask List of WhatsApp Business Account permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access pagingPaging Pagination information for cursor-based pagination Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned previousstring Graph API endpoint URL for the previous page of data nextstring Graph API endpoint URL for the next page of data 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WABA ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account - Migration Intent Details API | Developer Documentation WhatsApp Business Account - Migration Intent Details API Copy for LLM View as Markdown Version API for retrieving WhatsApp Business Account migration intent details and status information. This endpoint allows solution partners to retrieve comprehensive information about their WhatsApp Business Account migration intents, including current status and migration details. GET /{Version}/{Migration-Intent-ID} Retrieve comprehensive details about a WhatsApp Business Account migration intent, including its current status and migration information. Use Cases: Monitor migration intent lifecycle and status changes Verify migration intent configuration and current state Check migration progress and completion status Retrieve migration intent details for business workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Migration intent details can be cached for short periods, but status information may change frequently during migration processes. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Migration-Intent-IDstring·required Your Migration Intent ID. This ID is provided when you create the migration intent and can be found through migration management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, status). Available fields: id, status Responses Retrieve comprehensive details about a WhatsApp Business Account migration intent, including its current status and migration information. Use Cases: Monitor migration intent lifecycle and status changes Verify migration intent configuration and current state Check migration progress and completion status Retrieve migration intent details for business workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Migration intent details can be cached for short periods, but status information may change frequently during migration processes. Implement appropriate cache invalidation strategies. 200 Successfully retrieved migration intent details Content Type: application/json Schema: WhatsAppBusinessAccountMigrationIntent Show child attributes WhatsAppBusinessAccountMigrationIntent idstring·required Unique identifier for the migration intent statusWhatsAppBusinessAccountMigrationStatus·required Current status of the WhatsApp Business Account migration intent 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Migration Intent ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Bot - Bot Details API | Developer Documentation WhatsApp Business Bot - Bot Details API Copy for LLM View as Markdown Version This endpoint allows developers to retrieve comprehensive information about their WhatsApp Business Bot, including prompts, commands, and welcome message settings. This is essential for managing bot configuration and understanding current bot state. GET /{Version}/{WABA-Bot-ID} Retrieve comprehensive details about a WhatsApp Business Bot, including its prompts, commands, and welcome message configuration. Use Cases: Retrieve bot configuration and automated response settings Monitor available bot commands and their descriptions Check welcome message enablement status Validate bot state before implementing automation Audit bot configuration for business compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Bot details can be cached for moderate periods, but configuration may change when bot settings are updated. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WABA-Bot-IDstring·required Your WhatsApp Business Bot ID. This ID is provided when you create the bot and can be found in your Business Manager or through bot management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (prompts, commands, enable_welcome_message). Available fields: id, prompts, commands, enable_welcome_message Responses Retrieve comprehensive details about a WhatsApp Business Bot, including its prompts, commands, and welcome message configuration. Use Cases: Retrieve bot configuration and automated response settings Monitor available bot commands and their descriptions Check welcome message enablement status Validate bot state before implementing automation Audit bot configuration for business compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Bot details can be cached for moderate periods, but configuration may change when bot settings are updated. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Business Bot details Content Type: application/json Schema: WhatsAppBusinessBot Show child attributes WhatsAppBusinessBot idstring·required Unique identifier for the WhatsApp Business Bot promptsarray of string List of bot prompts and automated responses Show child attributes prompts[]string commandsarray of WhatsAppBusinessBotCommand List of available bot commands and their descriptions Show child attributes commands[]WhatsAppBusinessBotCommand Bot command configuration with name and description Show child attributes command_namestring·required Name of the bot command command_descriptionstring·required Description of what the command does enable_welcome_messageboolean Whether the welcome message is enabled for this bot 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Bot ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Block API | Developer Documentation WhatsApp Cloud API - Block API Copy for LLM View as Markdown Version The Block API allows businesses to manage blocked users on WhatsApp. Use this API to block users from sending messages to your business number, retrieve the list of blocked users, and unblock users when needed. For more information, see the Block Users Guide. Select language Select status code Select language Select status code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Business Encryption API | Developer Documentation WhatsApp Cloud API - Business Encryption API Copy for LLM View as Markdown Version API for managing WhatsApp Business Account encryption settings and public key management. This endpoint allows businesses to set up and manage encryption for their WhatsApp Business messaging by uploading and retrieving business public keys used for payload encryption. GET /{Version}/{Phone-Number-ID}/whatsapp_business_encryption Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch. Use Cases: Verify current encryption configuration Check public key signature validation status Retrieve public key for client-side encryption setup Monitor encryption key status for security compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Public key information can be cached for moderate periods, but signature status may change and should be checked regularly for security validation. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, all available fields will be returned. Available fields: business_public_key, business_public_key_signature_status Responses Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch. Use Cases: Verify current encryption configuration Check public key signature validation status Retrieve public key for client-side encryption setup Monitor encryption key status for security compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Public key information can be cached for moderate periods, but signature status may change and should be checked regularly for security validation. 200 Successfully retrieved business encryption public key information Content Type: application/json Schema: object Show child attributes dataarray of WhatsAppBusinessEncryptionInfo Show child attributes data[]WhatsAppBusinessEncryptionInfo Business encryption public key information and verification status Show child attributes business_public_keystring·required The business public key used for encrypting message payloads. This key is used to encrypt data channel requests and responses. Show child attributes business_public_key_signature_statusBusinessPublicKeyVerificationStatus·required Status of business public key signature verification 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{Phone-Number-ID}/whatsapp_business_encryption Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests. Use Cases: Initial setup of encryption for WhatsApp Business messaging Update existing public key for key rotation Enable secure payload encryption for sensitive business communications Configure encryption keys for compliance requirements Key Requirements: Must be a valid RSA public key in PEM format Key must meet Meta's security standards for encryption Only one active public key per phone number at a time Previous keys are replaced when new ones are uploaded Rate Limiting: Standard Graph API rate limits apply. Key uploads may have additional security-related rate limiting to prevent abuse. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list. Required Content Type: multipart/form-data Schema: WhatsAppBusinessEncryptionUploadRequest Show child attributes WhatsAppBusinessEncryptionUploadRequest business_public_keystring·required The business public key in PEM format to be uploaded and signed. Must be a valid RSA public key that will be used for payload encryption. Responses Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests. Use Cases: Initial setup of encryption for WhatsApp Business messaging Update existing public key for key rotation Enable secure payload encryption for sensitive business communications Configure encryption keys for compliance requirements Key Requirements: Must be a valid RSA public key in PEM format Key must meet Meta's security standards for encryption Only one active public key per phone number at a time Previous keys are replaced when new ones are uploaded Rate Limiting: Standard Graph API rate limits apply. Key uploads may have additional security-related rate limiting to prevent abuse. 200 Successfully uploaded and configured business encryption public key Content Type: application/json Schema: WhatsAppBusinessEncryptionUploadResponse Show child attributes WhatsAppBusinessEncryptionUploadResponse successboolean·required Indicates whether the public key was successfully uploaded and signed 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Business Encryption API | Developer Documentation WhatsApp Cloud API - Business Encryption API Copy for LLM View as Markdown Version API for managing WhatsApp Business Account encryption settings and public key management. This endpoint allows businesses to set up and manage encryption for their WhatsApp Business messaging by uploading and retrieving business public keys used for payload encryption. GET /{Version}/{Phone-Number-ID}/whatsapp_business_encryption Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch. Use Cases: Verify current encryption configuration Check public key signature validation status Retrieve public key for client-side encryption setup Monitor encryption key status for security compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Public key information can be cached for moderate periods, but signature status may change and should be checked regularly for security validation. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, all available fields will be returned. Available fields: business_public_key, business_public_key_signature_status Responses Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch. Use Cases: Verify current encryption configuration Check public key signature validation status Retrieve public key for client-side encryption setup Monitor encryption key status for security compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Public key information can be cached for moderate periods, but signature status may change and should be checked regularly for security validation. 200 Successfully retrieved business encryption public key information Content Type: application/json Schema: object Show child attributes dataarray of WhatsAppBusinessEncryptionInfo Show child attributes data[]WhatsAppBusinessEncryptionInfo Business encryption public key information and verification status Show child attributes business_public_keystring·required The business public key used for encrypting message payloads. This key is used to encrypt data channel requests and responses. Show child attributes business_public_key_signature_statusBusinessPublicKeyVerificationStatus·required Status of business public key signature verification 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{Phone-Number-ID}/whatsapp_business_encryption Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests. Use Cases: Initial setup of encryption for WhatsApp Business messaging Update existing public key for key rotation Enable secure payload encryption for sensitive business communications Configure encryption keys for compliance requirements Key Requirements: Must be a valid RSA public key in PEM format Key must meet Meta's security standards for encryption Only one active public key per phone number at a time Previous keys are replaced when new ones are uploaded Rate Limiting: Standard Graph API rate limits apply. Key uploads may have additional security-related rate limiting to prevent abuse. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list. Required Content Type: multipart/form-data Schema: WhatsAppBusinessEncryptionUploadRequest Show child attributes WhatsAppBusinessEncryptionUploadRequest business_public_keystring·required The business public key in PEM format to be uploaded and signed. Must be a valid RSA public key that will be used for payload encryption. Responses Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests. Use Cases: Initial setup of encryption for WhatsApp Business messaging Update existing public key for key rotation Enable secure payload encryption for sensitive business communications Configure encryption keys for compliance requirements Key Requirements: Must be a valid RSA public key in PEM format Key must meet Meta's security standards for encryption Only one active public key per phone number at a time Previous keys are replaced when new ones are uploaded Rate Limiting: Standard Graph API rate limits apply. Key uploads may have additional security-related rate limiting to prevent abuse. 200 Successfully uploaded and configured business encryption public key Content Type: application/json Schema: WhatsAppBusinessEncryptionUploadResponse Show child attributes WhatsAppBusinessEncryptionUploadResponse successboolean·required Indicates whether the public key was successfully uploaded and signed 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Calling API | Developer Documentation WhatsApp Cloud API - Calling API Copy for LLM View as Markdown Version The WhatsApp Business Calling API enables you to initiate and receive calls with users on WhatsApp using voice-over-internet protocol (VoIP). GET /{Version}/{Phone-Number-ID}/call_permissions Check whether you have permission to call a WhatsApp user and what actions are available. This endpoint returns the current permission status for calling a specific user, along with available actions and their limits. Permission Status: granted: You have active permission to call this user - pending: A permission request has been sent but not yet approved - denied: The user has denied call permissions - expired: Previous permission has expired Available Actions: start_call: Initiate a new call to this user - send_call_permission_request: Send a permission request to this user Error Handling: This endpoint may return various error codes including rate limiting errors if too many permission checks are made within a short period. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required The API version to use Phone-Number-IDstring·required The ID of the phone number registered with your WhatsApp Business Account Query Parameters user_wa_idstring·required The WhatsApp ID of the user you want to check call permissions for Responses Check whether you have permission to call a WhatsApp user and what actions are available. This endpoint returns the current permission status for calling a specific user, along with available actions and their limits. Permission Status: granted: You have active permission to call this user - pending: A permission request has been sent but not yet approved - denied: The user has denied call permissions - expired: Previous permission has expired Available Actions: start_call: Initiate a new call to this user - send_call_permission_request: Send a permission request to this user Error Handling: This endpoint may return various error codes including rate limiting errors if too many permission checks are made within a short period. 200 Call Permissions Check Success Content Type: application/json Schema: CallPermissionCheckResponsePayload Show child attributes CallPermissionCheckResponsePayload messaging_productstring·required Messaging product permissionobject·required Call permission details Show child attributes statusOne of "granted", "pending", "denied", "expired"·required Current permission status for calling this user expiration_timeinteger (int64) Unix timestamp when the permission expires (if applicable) actionsarray of object Available actions and their restrictions Show child attributes actions[]object Show child attributes action_nameOne of "start_call", "send_call_permission_request"·required Name of the action can_perform_actionboolean·required Whether the business can perform this action limitsarray of object Rate limits for this action Show child attributes limits[]object Show child attributes time_periodstring·required Time period for the limit current_usageinteger·required Current usage count max_allowedinteger·required Maximum allowed usage limit_expiration_timeinteger (int64) Unix timestamp when the limit resets 400 Bad Request - Invalid request parameters Content Type: application/json 429 Too Many Requests - Rate limit exceeded Content Type: application/json 403 Forbidden - Template not approved or insufficient permissions Content Type: application/json 500 Internal Server Error - An unexpected error occurred Content Type: application/json Select language Select status code POST /{Version}/{Phone-Number-ID}/calls Use this endpoint to initiate, accept, reject, or terminate WhatsApp calls. For initiating or managing a call: Send a POST request with the appropriate action (connect, pre_accept, accept, reject, terminate). For terminating a call: Send a POST request with action "terminate" and the call_id. Note: Response with error code 138006 indicates a lack of a call request permission for this business number from the WhatsApp user. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required The API version to use Phone-Number-IDstring·required The ID of the phone number registered with your WhatsApp Business Account Optional Content Type: application/json Schema: Must be one of: CallRequestPayload, CallTerminateRequestPayload Show child attributes Must be one of: CallRequestPayload, CallTerminateRequestPayload CallRequestPayload Show child attributes messaging_productstring·required Messaging product tostring·required The number being called (callee) actionOne of "connect", "pre_accept", "accept", "reject", "terminate"·required The action being taken on the given call ID sessionobject Contains the session description protocol (SDP) type and description language Show child attributes sdp_typeOne of "offer", "answer"·required SDP type - "offer" for connect action, "answer" for accept action sdpstring·required The SDP info of the device on the other end of the call. The SDP must be compliant with RFC 8866 biz_opaque_callback_datastring CallTerminateRequestPayload Show child attributes messaging_productstring·required Messaging product call_idstring·required The WhatsApp call ID action"terminate"·required Action to terminate the call Responses Use this endpoint to initiate, accept, reject, or terminate WhatsApp calls. For initiating or managing a call: Send a POST request with the appropriate action (connect, pre_accept, accept, reject, terminate). For terminating a call: Send a POST request with action "terminate" and the call_id. Note: Response with error code 138006 indicates a lack of a call request permission for this business number from the WhatsApp user. 200 Call Management Success Content Type: application/json Schema: Must be one of: CallResponsePayload, CallTerminateResponsePayload Show child attributes Must be one of: CallResponsePayload, CallTerminateResponsePayload CallResponsePayload Show child attributes messaging_productstring callsarray of object Show child attributes calls[]object Show child attributes idstring CallTerminateResponsePayload Show child attributes successboolean Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Commerce Settings API | Developer Documentation WhatsApp Cloud API - Commerce Settings API Copy for LLM View as Markdown Version Configure WhatsApp Business commerce settings including catalog visibility and shopping cart enablement. Retrieve and update commerce configurations for business phone numbers. Select language Select status code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Cloud API - Groups Management API | Developer Documentation WhatsApp Business Cloud API - Groups Management API Copy for LLM View as Markdown Version Create and manage WhatsApp Business groups with approval settings. Returns invite links for adding participants to groups. Retrieve active group lists with pagination support. Select language POST /{Version}/{Phone-Number-ID}/groups Create a new group and get an invite link Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required Phone-Number-IDstring·required Business phone number ID Required Content Type: application/json Schema: object Show child attributes messaging_product"whatsapp"·required Messaging product subjectstring·required Group subject. Maximum 128 characters. Whitespace is trimmed. descriptionstring Group description. Maximum 2048 characters. join_approval_modeOne of "approval_required", "auto_approve" Indicates if WhatsApp users who click the invitation link can join the group with or without being approved first. approval_required: WhatsApp users must be approved via join request before they can access the group auto_approve: WhatsApp users can join the group without approval Responses Create a new group and get an invite link 200 Group creation request submitted successfully Content Type: application/json Schema: object Show child attributes messaging_productstring request_idstring Group creation request ID 400 Bad Request - Invalid request parameters Content Type: application/json Schema: ErrorResponse Show child attributes ErrorResponse errorErrorObject·required Show child attributes messagestring·required Human-readable description of the error typestring·required Error type classification codeinteger·required Numeric error code 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: ErrorResponse Show child attributes ErrorResponse errorErrorObject·required Show child attributes messagestring·required Human-readable description of the error typestring·required Error type classification codeinteger·required Numeric error code 500 Internal Server Error - An unexpected error occurred Content Type: application/json Schema: ErrorResponse Show child attributes ErrorResponse errorErrorObject·required Show child attributes messagestring·required Human-readable description of the error typestring·required Error type classification codeinteger·required Numeric error code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Marketing Messages Lite API | Developer Documentation WhatsApp Cloud API - Marketing Messages Lite API Copy for LLM View as Markdown Version Send marketing template messages with automatic delivery optimization. Delivers relevant, timely messages to customers most likely to engage, with enhanced deliverability and down-funnel conversion insights. Endpoints POST /{Version}/{Phone-Number-ID}/marketing_messages POST /{Version}/{Phone-Number-ID}/marketing_messages Send marketing template messages using pre-approved templates. Supports optional product policy controls and message activity sharing settings. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required WhatsApp API version (e.g., v20.0) Phone-Number-IDstring·required WhatsApp Business Phone Number ID Required Content Type: application/json Schema: MarketingMessageRequestPayload Show child attributes MarketingMessageRequestPayload messaging_product"whatsapp"·required Messaging service used. Must be "whatsapp" recipient_type"individual"·required Type of recipient. Must be "individual" tostring·required WhatsApp ID or phone number of the message recipient type"template"·required Type of message. Must be "template" for marketing messages templateobject·required Show child attributes namestring·required Name of the template. languageLanguageObject·required Contains a language object. Specifies the language the template may be rendered in componentsarray of TemplateComponent Array of components objects containing the parameters of the message. Show child attributes components[]TemplateComponent product_policyOne of "CLOUD_API_FALLBACK", "STRICT" Optional product policy setting message_activity_sharingboolean Optional flag to control message activity sharing Responses Send marketing template messages using pre-approved templates. Supports optional product policy controls and message activity sharing settings. 200 Marketing message sent successfully Content Type: application/json Schema: MarketingMessageResponsePayload Show child attributes MarketingMessageResponsePayload contactsarray of object Show child attributes contacts[]object Show child attributes inputstring wa_idstring messagesarray of object Show child attributes messages[]object Show child attributes idstring message_statusOne of "accepted", "held_for_quality_assessment", "paused" The status of a WhatsApp message: accepted: The message has been accepted by WhatsApp and is being processed held_for_quality_assessment: The message is being held for quality assessment before delivery paused: The message delivery has been paused messaging_productstring 400 Bad Request - Invalid request parameters Content Type: application/json 401 Unauthorized - Invalid or missing access token Content Type: application/json 403 Forbidden - Template not approved or insufficient permissions Content Type: application/json Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Media Upload API | Developer Documentation WhatsApp Cloud API - Media Upload API Copy for LLM View as Markdown Version Upload media files (images, videos, audio, documents, stickers) to WhatsApp. Returns a media ID that can be used to send media messages. Supports multiple file formats and multipart form-data uploads. Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Message API | Developer Documentation WhatsApp Cloud API - Message API Copy for LLM View as Markdown Version Send and receive WhatsApp messages including text, media, templates, interactive messages, reactions, and more. Supports message status tracking, delivery receipts, and read confirmations. Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Phone Number API | Developer Documentation WhatsApp Cloud API - Phone Number APICopy for LLMView as MarkdownVersionWhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. Cloud API OverviewCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.https://developers.facebook.com/docs/whatsapp/cloud-api/overview Getting Started with Cloud APITo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API Get Started guide, these assets will be created for you. Get Started as a Solution PartnerThis guide goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers. Migrating from On-Premises API to Cloud APIThis guide explains how to migrate business phone numbers from On-Premises API to Cloud API. EnvironmentThis collection has a corresponding WhatsApp Cloud API Postman environment which you must select when using the collection. Set current values for the variables defined in this environment if you wish to use the collection to perform queries.You can find most of these values in the WhatsApp Manager or the WhatsApp > Getting Started panel in the app dashboard. However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values. Access tokensThe API supports both user and system user access tokens. You can get a user access token by loading your app in the app dashboard and navigating to the WhatsApp > Getting Started panel.Since user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See Access Tokens to learn how to create a system user and system user access token.Once you have your token, save it as a current value in the environment. Business portfolio IDYou can get your business portfolio ID by signing into the Meta Business Suite. The ID appears in the URL as the business_id query string parameter value. Once you save this as a current value in the environment, go to the WhatsApp Business Account (WABA) folder and run the Get all owned WABAs query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID. PermissionsThe API only relies on two permissions:whatsapp_business_managementwhatsapp_business_messagingNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.Queries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway. Access token debuggerYou can paste any token you generate into the access token debugger to see what type of token it is and what permission you have granted to your app. PaginationEndpoints that return lists/collections may paginate results (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned. WhatsApp Cloud API - Phone Number API | Developer Documentation WhatsApp Cloud API - Phone Number APICopy for LLMView as MarkdownVersionWhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. Cloud API OverviewCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.https://developers.facebook.com/docs/whatsapp/cloud-api/overview Getting Started with Cloud APITo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API Get Started guide, these assets will be created for you. Get Started as a Solution PartnerThis guide goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers. Migrating from On-Premises API to Cloud APIThis guide explains how to migrate business phone numbers from On-Premises API to Cloud API. EnvironmentThis collection has a corresponding WhatsApp Cloud API Postman environment which you must select when using the collection. Set current values for the variables defined in this environment if you wish to use the collection to perform queries.You can find most of these values in the WhatsApp Manager or the WhatsApp > Getting Started panel in the app dashboard. However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values. Access tokensThe API supports both user and system user access tokens. You can get a user access token by loading your app in the app dashboard and navigating to the WhatsApp > Getting Started panel.Since user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See Access Tokens to learn how to create a system user and system user access token.Once you have your token, save it as a current value in the environment. Business portfolio IDYou can get your business portfolio ID by signing into the Meta Business Suite. The ID appears in the URL as the business_id query string parameter value. Once you save this as a current value in the environment, go to the WhatsApp Business Account (WABA) folder and run the Get all owned WABAs query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID. PermissionsThe API only relies on two permissions:whatsapp_business_managementwhatsapp_business_messagingNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.Queries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway. Access token debuggerYou can paste any token you generate into the access token debugger to see what type of token it is and what permission you have granted to your app. PaginationEndpoints that return lists/collections may paginate results (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned. WhatsApp Cloud API - Phone Number API | Developer Documentation WhatsApp Cloud API - Phone Number APICopy for LLMView as MarkdownVersionWhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. Cloud API OverviewCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.https://developers.facebook.com/docs/whatsapp/cloud-api/overview Getting Started with Cloud APITo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API Get Started guide, these assets will be created for you. Get Started as a Solution PartnerThis guide goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers. Migrating from On-Premises API to Cloud APIThis guide explains how to migrate business phone numbers from On-Premises API to Cloud API. EnvironmentThis collection has a corresponding WhatsApp Cloud API Postman environment which you must select when using the collection. Set current values for the variables defined in this environment if you wish to use the collection to perform queries.You can find most of these values in the WhatsApp Manager or the WhatsApp > Getting Started panel in the app dashboard. However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values. Access tokensThe API supports both user and system user access tokens. You can get a user access token by loading your app in the app dashboard and navigating to the WhatsApp > Getting Started panel.Since user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See Access Tokens to learn how to create a system user and system user access token.Once you have your token, save it as a current value in the environment. Business portfolio IDYou can get your business portfolio ID by signing into the Meta Business Suite. The ID appears in the URL as the business_id query string parameter value. Once you save this as a current value in the environment, go to the WhatsApp Business Account (WABA) folder and run the Get all owned WABAs query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID. PermissionsThe API only relies on two permissions:whatsapp_business_managementwhatsapp_business_messagingNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.Queries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway. Access token debuggerYou can paste any token you generate into the access token debugger to see what type of token it is and what permission you have granted to your app. PaginationEndpoints that return lists/collections may paginate results (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned. WhatsApp Cloud API - Settings API | Developer Documentation WhatsApp Cloud API - Settings API Copy for LLM View as Markdown Version The Settings API allows you to configure various features and settings for your WhatsApp Business Account phone numbers. You can manage calling settings, user identity change settings, payload encryption, and data storage configurations. Select language Select status code Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Account Phone Number Verification - Verify Code API | Developer Documentation WhatsApp Business Account Phone Number Verification - Verify Code API Copy for LLM View as Markdown Version API for verifying phone number verification codes for WhatsApp Business Account phone numbers. This endpoint allows businesses to verify phone number verification codes sent during the phone number registration or verification process. POST /{Version}/{Phone-Number-ID}/verify_code Verify a phone number verification code for a WhatsApp Business Account phone number. This endpoint is used to complete the phone number verification process by submitting the verification code received via SMS or voice call. Use Cases: Complete phone number verification during initial setup Verify phone number ownership for messaging capabilities Finalize phone number registration process Complete phone number migration verification Rate Limiting: Verification attempts are rate-limited to prevent abuse. Failed attempts may result in temporary blocking. Use appropriate retry logic with exponential backoff. Security: Verification codes are time-limited (typically 10 minutes) and single-use. Multiple failed attempts may trigger additional security measures. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Content-TypeOne of "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·required Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Phone-Number-IDstring·required The WhatsApp Business Account phone number ID that needs verification. This ID is provided when you add a phone number to your WhatsApp Business Account. Required Content Type: application/json Schema: VerifyCodeRequest Show child attributes VerifyCodeRequest codestring·required The verification code received via SMS or voice call Responses Verify a phone number verification code for a WhatsApp Business Account phone number. This endpoint is used to complete the phone number verification process by submitting the verification code received via SMS or voice call. Use Cases: Complete phone number verification during initial setup Verify phone number ownership for messaging capabilities Finalize phone number registration process Complete phone number migration verification Rate Limiting: Verification attempts are rate-limited to prevent abuse. Failed attempts may result in temporary blocking. Use appropriate retry logic with exponential backoff. Security: Verification codes are time-limited (typically 10 minutes) and single-use. Multiple failed attempts may trigger additional security measures. 200 Successfully verified the phone number verification code Content Type: application/json Schema: VerifyCodeResponse Show child attributes VerifyCodeResponse successboolean·required Indicates whether the verification code was successfully verified idstring The phone number ID that was verified 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Phone number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Invalid or expired verification code Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - WhatsApp Business QR Code Management API | Developer Documentation WhatsApp Cloud API - WhatsApp Business QR Code Management APICopy for LLMView as MarkdownVersionAPI for managing WhatsApp Business Account message QR code collections.Provides endpoints for listing all message QR codes and creating new ones.Message QR codes generate WhatsApp deep links with pre-filled messages that customerscan use to start conversations. Each QR code has a unique 14-character identifier.Requirements: WhatsApp Business Account with whatsapp_business_management permission,verified phone number, and valid system user access token. WhatsApp Cloud API - WhatsApp Business QR Code Management API | Developer Documentation WhatsApp Cloud API - WhatsApp Business QR Code Management APICopy for LLMView as MarkdownVersionAPI for managing WhatsApp Business Account message QR code collections.Provides endpoints for listing all message QR codes and creating new ones.Message QR codes generate WhatsApp deep links with pre-filled messages that customerscan use to start conversations. Each QR code has a unique 14-character identifier.Requirements: WhatsApp Business Account with whatsapp_business_management permission,verified phone number, and valid system user access token. WhatsApp Cloud API - WhatsApp Business QR Code Management API | Developer Documentation WhatsApp Cloud API - WhatsApp Business QR Code Management APICopy for LLMView as MarkdownVersionAPI for managing WhatsApp Business Account message QR code collections.Provides endpoints for listing all message QR codes and creating new ones.Message QR codes generate WhatsApp deep links with pre-filled messages that customerscan use to start conversations. Each QR code has a unique 14-character identifier.Requirements: WhatsApp Business Account with whatsapp_business_management permission,verified phone number, and valid system user access token. WhatsApp Cloud API - WhatsApp Business QR Code Management API | Developer Documentation WhatsApp Cloud API - WhatsApp Business QR Code Management APICopy for LLMView as MarkdownVersionAPI for managing WhatsApp Business Account message QR code collections.Provides endpoints for listing all message QR codes and creating new ones.Message QR codes generate WhatsApp deep links with pre-filled messages that customerscan use to start conversations. Each QR code has a unique 14-character identifier.Requirements: WhatsApp Business Account with whatsapp_business_management permission,verified phone number, and valid system user access token. WhatsApp Cloud API - WhatsApp Business QR Code Management API | Developer Documentation WhatsApp Cloud API - WhatsApp Business QR Code Management APICopy for LLMView as MarkdownVersionAPI for managing WhatsApp Business Account message QR code collections.Provides endpoints for listing all message QR codes and creating new ones.Message QR codes generate WhatsApp deep links with pre-filled messages that customerscan use to start conversations. Each QR code has a unique 14-character identifier.Requirements: WhatsApp Business Account with whatsapp_business_management permission,verified phone number, and valid system user access token. WhatsApp Business Pre-Verified Phone Number Partners API | Developer Documentation WhatsApp Business Pre-Verified Phone Number Partners API Copy for LLM View as Markdown Version API for retrieving partner businesses associated with a WhatsApp Business Pre-Verified Phone Number. This endpoint allows authorized applications to retrieve the list of partner businesses that have been granted access to a specific pre-verified phone number. GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Pre-Verified-Phone-Number-IDstring·required Your Pre-Verified Phone Number ID. This ID is provided when the pre-verified phone number is created and can be found in your WhatsApp Business Account management interface. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, created_time, updated_time, verification_status, primary_page, timezone_id, two_factor_type limitinteger [min: 1, max: 100] Maximum number of partner businesses to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use the 'after' cursor from a previous response to get the next page. beforestring Cursor for pagination. Use the 'before' cursor from a previous response to get the previous page. Responses Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. 200 Successfully retrieved partner businesses for the pre-verified phone number Content Type: application/json Schema: WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse Show child attributes WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse dataarray of BusinessPartner·required List of partner businesses with access to the pre-verified phone number Show child attributes data[]BusinessPartner Business entity that has partner access to the pre-verified phone number Show child attributes idstring·required Unique identifier for the partner business namestring·required Name of the partner business created_timestring (date-time) ISO 8601 timestamp when the business was created updated_timestring (date-time) ISO 8601 timestamp when the business was last updated verification_statusOne of "not_verified", "pending", "verified" Business verification status primary_pagestring Primary Facebook Page ID associated with the business timezone_idinteger Timezone identifier for the business location two_factor_typeOne of "none", "admin_required" Two-factor authentication method configured for the business pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Pre-Verified Phone Number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Pre-Verified Phone Number Partners API | Developer Documentation WhatsApp Business Pre-Verified Phone Number Partners API Copy for LLM View as Markdown Version API for retrieving partner businesses associated with a WhatsApp Business Pre-Verified Phone Number. This endpoint allows authorized applications to retrieve the list of partner businesses that have been granted access to a specific pre-verified phone number. GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Pre-Verified-Phone-Number-IDstring·required Your Pre-Verified Phone Number ID. This ID is provided when the pre-verified phone number is created and can be found in your WhatsApp Business Account management interface. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, created_time, updated_time, verification_status, primary_page, timezone_id, two_factor_type limitinteger [min: 1, max: 100] Maximum number of partner businesses to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use the 'after' cursor from a previous response to get the next page. beforestring Cursor for pagination. Use the 'before' cursor from a previous response to get the previous page. Responses Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. 200 Successfully retrieved partner businesses for the pre-verified phone number Content Type: application/json Schema: WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse Show child attributes WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse dataarray of BusinessPartner·required List of partner businesses with access to the pre-verified phone number Show child attributes data[]BusinessPartner Business entity that has partner access to the pre-verified phone number Show child attributes idstring·required Unique identifier for the partner business namestring·required Name of the partner business created_timestring (date-time) ISO 8601 timestamp when the business was created updated_timestring (date-time) ISO 8601 timestamp when the business was last updated verification_statusOne of "not_verified", "pending", "verified" Business verification status primary_pagestring Primary Facebook Page ID associated with the business timezone_idinteger Timezone identifier for the business location two_factor_typeOne of "none", "admin_required" Two-factor authentication method configured for the business pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Pre-Verified Phone Number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Pre-Verified Phone Number Partners API | Developer Documentation WhatsApp Business Pre-Verified Phone Number Partners API Copy for LLM View as Markdown Version API for retrieving partner businesses associated with a WhatsApp Business Pre-Verified Phone Number. This endpoint allows authorized applications to retrieve the list of partner businesses that have been granted access to a specific pre-verified phone number. GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Pre-Verified-Phone-Number-IDstring·required Your Pre-Verified Phone Number ID. This ID is provided when the pre-verified phone number is created and can be found in your WhatsApp Business Account management interface. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, created_time, updated_time, verification_status, primary_page, timezone_id, two_factor_type limitinteger [min: 1, max: 100] Maximum number of partner businesses to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use the 'after' cursor from a previous response to get the next page. beforestring Cursor for pagination. Use the 'before' cursor from a previous response to get the previous page. Responses Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. 200 Successfully retrieved partner businesses for the pre-verified phone number Content Type: application/json Schema: WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse Show child attributes WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse dataarray of BusinessPartner·required List of partner businesses with access to the pre-verified phone number Show child attributes data[]BusinessPartner Business entity that has partner access to the pre-verified phone number Show child attributes idstring·required Unique identifier for the partner business namestring·required Name of the partner business created_timestring (date-time) ISO 8601 timestamp when the business was created updated_timestring (date-time) ISO 8601 timestamp when the business was last updated verification_statusOne of "not_verified", "pending", "verified" Business verification status primary_pagestring Primary Facebook Page ID associated with the business timezone_idinteger Timezone identifier for the business location two_factor_typeOne of "none", "admin_required" Two-factor authentication method configured for the business pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Pre-Verified Phone Number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Pre-Verified Phone Number Partners API | Developer Documentation WhatsApp Business Pre-Verified Phone Number Partners API Copy for LLM View as Markdown Version API for retrieving partner businesses associated with a WhatsApp Business Pre-Verified Phone Number. This endpoint allows authorized applications to retrieve the list of partner businesses that have been granted access to a specific pre-verified phone number. GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Pre-Verified-Phone-Number-IDstring·required Your Pre-Verified Phone Number ID. This ID is provided when the pre-verified phone number is created and can be found in your WhatsApp Business Account management interface. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name). Available fields: id, name, created_time, updated_time, verification_status, primary_page, timezone_id, two_factor_type limitinteger [min: 1, max: 100] Maximum number of partner businesses to return per page. Default is 25, maximum is 100. afterstring Cursor for pagination. Use the 'after' cursor from a previous response to get the next page. beforestring Cursor for pagination. Use the 'before' cursor from a previous response to get the previous page. Responses Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: Monitor partner business relationships and access permissions Verify which businesses have access to shared pre-verified phone numbers Retrieve partner business information for operational purposes Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Partner information can be cached for moderate periods, but partnership relationships may change. Implement appropriate cache invalidation strategies. 200 Successfully retrieved partner businesses for the pre-verified phone number Content Type: application/json Schema: WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse Show child attributes WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse dataarray of BusinessPartner·required List of partner businesses with access to the pre-verified phone number Show child attributes data[]BusinessPartner Business entity that has partner access to the pre-verified phone number Show child attributes idstring·required Unique identifier for the partner business namestring·required Name of the partner business created_timestring (date-time) ISO 8601 timestamp when the business was created updated_timestring (date-time) ISO 8601 timestamp when the business was last updated verification_statusOne of "not_verified", "pending", "verified" Business verification status primary_pagestring Primary Facebook Page ID associated with the business timezone_idinteger Timezone identifier for the business location two_factor_typeOne of "none", "admin_required" Two-factor authentication method configured for the business pagingCursorPaging Cursor-based pagination information Show child attributes cursorsobject Show child attributes beforestring Cursor pointing to the start of the page of data that has been returned afterstring Cursor pointing to the end of the page of data that has been returned nextstring Graph API endpoint URL for the next page of results previousstring Graph API endpoint URL for the previous page of results 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Pre-Verified Phone Number ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Profile Node API | Developer Documentation WhatsApp Business Profile Node API Copy for LLM View as Markdown Version This endpoint allows applications to retrieve comprehensive information about WhatsApp Business Profiles, including profile details, contact information, and business metadata. This is essential for managing business profile lifecycle and understanding current configuration state. GET /{Version}/{WhatsApp-Business-Profile-ID} Retrieve comprehensive details about a WhatsApp Business Profile, including business information, contact details, and profile configuration. Use Cases: Retrieve business profile information and metadata Verify profile configuration and contact details Check profile status and business information Validate profile state before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Profile details can be cached for moderate periods, but business information may change occasionally. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Business-Profile-IDstring·required Your WhatsApp Business Profile ID. This ID is provided when the profile is created and can be found in your WhatsApp Business Manager or through business management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id and any available profile fields). Available fields: id, account_name, description, email, about, address, vertical, websites, profile_picture_url, messaging_product Responses Retrieve comprehensive details about a WhatsApp Business Profile, including business information, contact details, and profile configuration. Use Cases: Retrieve business profile information and metadata Verify profile configuration and contact details Check profile status and business information Validate profile state before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Profile details can be cached for moderate periods, but business information may change occasionally. Implement appropriate cache invalidation strategies. 200 Successfully retrieved WhatsApp Business Profile details Content Type: application/json Schema: WhatsAppBusinessProfileNode Show child attributes WhatsAppBusinessProfileNode idstring·required Unique identifier for the WhatsApp Business Profile account_namestring Name of the business account descriptionstring Business description text emailstring (email) Contact email address of the business aboutstring About section text for the business profile addressstring Physical address of the business verticalWhatsAppBusinessVertical Industry vertical classification for the business websitesarray of string (uri) List of website URLs associated with the business Show child attributes websites[]string (uri) profile_picture_urlstring (uri) URL of the business profile picture profile_picture_handlestring Handle of the profile picture for upload operations messaging_product"whatsapp" The messaging service used 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Profile ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code POST /{Version}/{WhatsApp-Business-Profile-ID} Update the WhatsApp Business Profile information such as business description, email, address, and other profile details. This operation corresponds to the GraphWhatsAppBusinessProfilePost functionality. Use Cases: Update business profile information and metadata Modify contact details and business description Change business vertical classification Update website URLs and profile picture Maintain current business profile information Profile Picture Upload: It is recommended to use the Resumable Upload API to obtain an upload ID, then use this upload ID to obtain the picture handle for the profile_picture_handle field. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. WhatsApp-Business-Profile-IDstring·required Your WhatsApp Business Profile ID. This ID is provided when the profile is created and can be found in your WhatsApp Business Manager or through business management APIs. Required Content Type: application/json Schema: WhatsAppBusinessProfileUpdateRequest Show child attributes WhatsAppBusinessProfileUpdateRequest messaging_product"whatsapp"·required The messaging service used for the request account_namestring Name of the business account descriptionstring Business description text emailstring (email) Contact email address of the business aboutstring About section text for the business profile addressstring Physical address of the business verticalWhatsAppBusinessVertical Industry vertical classification for the business websitesarray of string (uri) List of website URLs associated with the business Show child attributes websites[]string (uri) profile_picture_handlestring Handle of the profile picture generated from Resumable Upload API Responses Update the WhatsApp Business Profile information such as business description, email, address, and other profile details. This operation corresponds to the GraphWhatsAppBusinessProfilePost functionality. Use Cases: Update business profile information and metadata Modify contact details and business description Change business vertical classification Update website URLs and profile picture Maintain current business profile information Profile Picture Upload: It is recommended to use the Resumable Upload API to obtain an upload ID, then use this upload ID to obtain the picture handle for the profile_picture_handle field. Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. 200 Successfully updated WhatsApp Business Profile Content Type: application/json Schema: WhatsAppBusinessProfileUpdateResponse Show child attributes WhatsAppBusinessProfileUpdateResponse idstring WhatsApp Business Profile ID that was updated successboolean Indicates if the update was successful 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - WhatsApp Business Profile ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Accept Deactivation Request API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Accept Deactivation Request API Copy for LLM View as Markdown Version API for accepting deactivation requests for WhatsApp Business Multi-Partner Solutions. This endpoint allows solution partners to accept pending deactivation requests for their Multi-Partner Solutions. POST /{Version}/{Solution-ID}/accept_deactivation_request Accepts a pending deactivation request for a WhatsApp Business Multi-Partner Solution. This endpoint completes the partner approval workflow by accepting a deactivation request that was previously initiated by another solution partner. Upon successful acceptance, the solution status transitions from ACTIVE to DEACTIVATED, and the pending request status changes from PENDING_DEACTIVATION to NONE. Important Business Logic: Solution must be in ACTIVE status with PENDING_DEACTIVATION pending status All outstanding payments and invoices must be settled before acceptance Active marketing campaigns must be concluded or transferred Webhook notifications will be sent to all solution partners upon completion Solution resources and permissions will be cleaned up according to policy Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version Solution-IDstring·required Unique identifier for the WhatsApp Business Solution Query Parameters fieldsstring Comma-separated list of fields to return in the response. Available Fields: id, name, status, status_for_pending_request, owner_permissions Default Fields: name, status, status_for_pending_request Optional Content Type: application/json Schema: object Responses Accepts a pending deactivation request for a WhatsApp Business Multi-Partner Solution. This endpoint completes the partner approval workflow by accepting a deactivation request that was previously initiated by another solution partner. Upon successful acceptance, the solution status transitions from ACTIVE to DEACTIVATED, and the pending request status changes from PENDING_DEACTIVATION to NONE. Important Business Logic: Solution must be in ACTIVE status with PENDING_DEACTIVATION pending status All outstanding payments and invoices must be settled before acceptance Active marketing campaigns must be concluded or transferred Webhook notifications will be sent to all solution partners upon completion Solution resources and permissions will be cleaned up according to policy 200 Deactivation request accepted successfully. Solution status updated to DEACTIVATED. Content Type: application/json Schema: WhatsAppBusinessSolution Show child attributes WhatsAppBusinessSolution idstring·required Unique identifier for the WhatsApp Business Solution namestring·required Human-readable name for the solution (UGC text, 2-75 characters) statusWhatsAppBusinessSolutionStatus·required Current status of the WhatsApp Business Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending requests for the solution owner_permissionsarray of WhatsAppBusinessAccountPermissionTask Array of permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access 400 Bad Request - Invalid request parameters or malformed solution ID format. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 401 Unauthorized - Invalid, missing, or expired access token. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 403 Forbidden - Insufficient permissions or app not authorized for this solution. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 404 Not Found - Solution ID does not exist or is not accessible to the requesting app. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 422 Unprocessable Entity - Valid parameters but business logic prevents processing (e.g., wrong solution state, outstanding payments). Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 429 Too Many Requests - Rate limit exceeded. Use exponential backoff for retries. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message 500 Internal Server Error - Unexpected server error. Retry with exponential backoff if is_transient is true. Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typeOne of "OAuthException", "GraphMethodException", "GraphAPIException"·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode fbtrace_idstring Internal trace ID for debugging is_transientboolean Whether this error might be resolved by retrying error_user_titlestring User-friendly error title error_user_msgstring User-friendly error message Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Access Token API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Access Token API Copy for LLM View as Markdown Version API for retrieving granular BISU (Business Integration System User) access tokens for Multi-Partner Solution partners. This endpoint allows solution partners to obtain granular access tokens that provide secure, scoped access to WhatsApp Business Accounts shared with their Multi-Partner Solution. GET /{Version}/{Solution-ID}/access_token Retrieve a granular BISU access token for accessing customer business resources through the Multi-Partner Solution. The token provides secure, scoped access to WhatsApp Business Accounts that have been shared with the solution. Use Cases: Obtain secure access tokens for partner applications to access customer business resources Enable multi-tenant partner architectures with dedicated tokens per customer business Support secure API operations on shared WhatsApp Business Accounts Implement proper security boundaries between different customer businesses Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Token Management: Access tokens are time-limited and should be refreshed before expiration. Store tokens securely and implement proper token rotation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required Your Multi-Partner Solution ID. This ID is provided when you create the solution and can be found in your Partner Dashboard or through solution management APIs. Query Parameters business_idstring·required The customer business ID for which you want to retrieve an access token. This must be a business that has shared a WhatsApp Business Account with your Multi-Partner Solution. Responses Retrieve a granular BISU access token for accessing customer business resources through the Multi-Partner Solution. The token provides secure, scoped access to WhatsApp Business Accounts that have been shared with the solution. Use Cases: Obtain secure access tokens for partner applications to access customer business resources Enable multi-tenant partner architectures with dedicated tokens per customer business Support secure API operations on shared WhatsApp Business Accounts Implement proper security boundaries between different customer businesses Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Token Management: Access tokens are time-limited and should be refreshed before expiration. Store tokens securely and implement proper token rotation strategies. 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution ID or business ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Reject Deactivation Request API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Reject Deactivation Request API Copy for LLM View as Markdown Version API for rejecting deactivation requests for Multi-Partner Solutions. This endpoint allows solution partners to reject pending deactivation requests for their Multi-Partner Solutions. POST /{Version}/{Solution-ID}/reject_deactivation_request Reject a pending deactivation request for a Multi-Partner Solution. This endpoint allows solution partners to decline deactivation requests from solution owners, maintaining the solution in its current active operational state. Use Cases: Reject deactivation requests from solution owners Maintain active solution partnerships when deactivation is not appropriate Respond programmatically to deactivation requests through API integration Keep solutions operational when business requirements or partnerships change Business Logic: Solution status remains ACTIVE after successful rejection StatusForPendingRequest transitions from PENDING_DEACTIVATION to NONE All existing solution configurations and permissions are preserved Solution partners receive notifications about the rejection decision Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Permissions: Requires whatsapp_business_management permission and valid solution partnership relationship. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required Your Multi-Partner Solution ID with a pending deactivation request. This ID is provided when you create the solution and can be found in your Partner Dashboard or through solution management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions Required Content Type: application/json Schema: object Show child attributes reject_deactivation_requestboolean·required Set to true to reject the pending deactivation request Responses Reject a pending deactivation request for a Multi-Partner Solution. This endpoint allows solution partners to decline deactivation requests from solution owners, maintaining the solution in its current active operational state. Use Cases: Reject deactivation requests from solution owners Maintain active solution partnerships when deactivation is not appropriate Respond programmatically to deactivation requests through API integration Keep solutions operational when business requirements or partnerships change Business Logic: Solution status remains ACTIVE after successful rejection StatusForPendingRequest transitions from PENDING_DEACTIVATION to NONE All existing solution configurations and permissions are preserved Solution partners receive notifications about the rejection decision Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Permissions: Requires whatsapp_business_management permission and valid solution partnership relationship. 200 Successfully rejected the deactivation request Content Type: application/json Schema: WhatsAppBusinessSolution Show child attributes WhatsAppBusinessSolution idstring·required Unique identifier for the Multi-Partner Solution namestring·required Human-readable name of the Multi-Partner Solution statusWhatsAppBusinessSolutionStatus·required Current effective status of the Multi-Partner Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending solution status transition requests owner_appApplicationNode Meta application that owns the Multi-Partner Solution Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application owner_permissionsarray of WhatsAppBusinessAccountPermissionTask List of WhatsApp Business Account permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or unauthorized access Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution not found or not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Invalid solution state or business logic violation Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error type classification codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Send Deactivation Request API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Send Deactivation Request API Copy for LLM View as Markdown Version API for sending deactivation requests for Multi-Partner Solutions. This endpoint allows solution partners to request deactivation of their Multi-Partner Solutions. POST /{Version}/{Solution-ID}/send_deactivation_request Submit a deactivation request for a Multi-Partner Solution. This initiates a workflow to transition the solution from its current state to deactivated, following proper business validation and approval processes. Use Cases: Request deactivation of an active Multi-Partner Solution Initiate solution lifecycle transition management Trigger business workflow for solution deactivation approval Programmatically manage solution lifecycle states Business Logic: Solution must be in ACTIVE or INITIATED state to be eligible for deactivation Deactivation requests are processed asynchronously Solution status will transition to PENDING_DEACTIVATION during processing Final deactivation requires business approval workflow completion Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Workflow: Validate solution ownership and permissions Check solution eligibility for deactivation Submit deactivation request to business workflow Return confirmation with tracking identifier Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required Your Multi-Partner Solution ID. This ID is provided when you create the solution and can be found in your Partner Dashboard or through solution management APIs. Optional Content Type: application/json Schema: WhatsAppBusinessSolutionDeactivationRequest Show child attributes WhatsAppBusinessSolutionDeactivationRequest reasonstring Optional reason for the deactivation request Responses Submit a deactivation request for a Multi-Partner Solution. This initiates a workflow to transition the solution from its current state to deactivated, following proper business validation and approval processes. Use Cases: Request deactivation of an active Multi-Partner Solution Initiate solution lifecycle transition management Trigger business workflow for solution deactivation approval Programmatically manage solution lifecycle states Business Logic: Solution must be in ACTIVE or INITIATED state to be eligible for deactivation Deactivation requests are processed asynchronously Solution status will transition to PENDING_DEACTIVATION during processing Final deactivation requires business approval workflow completion Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Workflow: Validate solution ownership and permissions Check solution eligibility for deactivation Submit deactivation request to business workflow Return confirmation with tracking identifier 200 Successfully submitted deactivation request Content Type: application/json Schema: WhatsAppBusinessSolutionDeactivationResponse Show child attributes WhatsAppBusinessSolutionDeactivationResponse successboolean·required Indicates whether the deactivation request was successfully submitted messagestring·required Human-readable message describing the result request_idstring Unique identifier for tracking the deactivation request 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Solution is not eligible for deactivation Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Solution Accept API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Solution Accept API Copy for LLM View as Markdown Version API for accepting Multi-Partner Solution partnership invitations. This endpoint allows partner applications to accept invitations to participate in Multi-Partner Solutions. POST /{Version}/{Solution-ID}/accept Accept an invitation to participate in a Multi-Partner Solution as a partner application. This endpoint transitions the partner's status from NOTIFICATION_SENT to ACCEPTED, enabling the solution to progress toward ACTIVE status once all required partners accept. Use Cases: Accept partnership invitations for Multi-Partner Solutions Activate partner participation in existing solutions Confirm partner app's commitment to solution terms and conditions Enable solution workflow progression from INITIATED to ACTIVE status Business Logic: Only invited partner apps can accept solution invitations Solution must be in INITIATED status to accept partnerships Partner status transitions from NOTIFICATION_SENT to ACCEPTED Solution may become ACTIVE once all required partners accept Acceptance creates formal partnership agreement between apps Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Validation: Partner app must have received a valid solution invitation Solution must exist and be accessible to the partner app Partner app must have proper permissions and capabilities Acceptance request must include valid partner app identification Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required ID of the Multi-Partner Solution to accept. This ID is provided in the original invitation and can be found in partner notifications or solution management interfaces. Required Content Type: application/json Schema: WhatsAppBusinessSolutionAcceptRequest Show child attributes WhatsAppBusinessSolutionAcceptRequest partner_app_idstring·required ID of the partner application accepting the solution invitation. This must match the app ID that received the original invitation. log_session_idstring Optional session identifier for logging and debugging purposes. Used to track the acceptance flow across multiple API calls. Responses Accept an invitation to participate in a Multi-Partner Solution as a partner application. This endpoint transitions the partner's status from NOTIFICATION_SENT to ACCEPTED, enabling the solution to progress toward ACTIVE status once all required partners accept. Use Cases: Accept partnership invitations for Multi-Partner Solutions Activate partner participation in existing solutions Confirm partner app's commitment to solution terms and conditions Enable solution workflow progression from INITIATED to ACTIVE status Business Logic: Only invited partner apps can accept solution invitations Solution must be in INITIATED status to accept partnerships Partner status transitions from NOTIFICATION_SENT to ACCEPTED Solution may become ACTIVE once all required partners accept Acceptance creates formal partnership agreement between apps Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Validation: Partner app must have received a valid solution invitation Solution must exist and be accessible to the partner app Partner app must have proper permissions and capabilities Acceptance request must include valid partner app identification 200 Multi-Partner Solution invitation accepted successfully. The partner's status has been updated to ACCEPTED and the solution may progress toward ACTIVE status. Content Type: application/json Schema: WhatsAppBusinessSolutionAcceptResponse Show child attributes WhatsAppBusinessSolutionAcceptResponse solution_idstring·required ID of the Multi-Partner Solution that was accepted partner_statusWhatsAppBusinessSolutionPartnerStatus·required Current status of the partner's participation in the Multi-Partner Solution successboolean·required Indicates whether the acceptance was successful messagestring Human-readable confirmation message update_timestring (date-time) Timestamp when the acceptance was processed 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or not invited to solution Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Solution cannot be accepted in current state Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Solution Details API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Solution Details API Copy for LLM View as Markdown Version API for retrieving Multi-Partner Solution details and configuration information. This endpoint allows solution partners to retrieve comprehensive information about their Multi-Partner Solutions, including status, permissions, and ownership details. GET /{Version}/{Solution-ID} Retrieve comprehensive details about a Multi-Partner Solution, including its current status, pending status transitions, ownership information, and granted permissions. Use Cases: Monitor solution lifecycle and status changes Verify solution configuration before business onboarding Check pending approval requests and status transitions Retrieve solution ownership and permission details Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution details can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required Your Multi-Partner Solution ID. This ID is provided when you create the solution and can be found in your Partner Dashboard or through solution management APIs. Query Parameters fieldsstring Comma-separated list of fields to include in the response. If not specified, default fields will be returned (name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions Responses Retrieve comprehensive details about a Multi-Partner Solution, including its current status, pending status transitions, ownership information, and granted permissions. Use Cases: Monitor solution lifecycle and status changes Verify solution configuration before business onboarding Check pending approval requests and status transitions Retrieve solution ownership and permission details Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Solution details can be cached for short periods, but status information may change frequently during transitions. Implement appropriate cache invalidation strategies. 200 Successfully retrieved Multi-Partner Solution details Content Type: application/json Schema: WhatsAppBusinessSolution Show child attributes WhatsAppBusinessSolution idstring·required Unique identifier for the Multi-Partner Solution namestring·required Human-readable name of the Multi-Partner Solution statusWhatsAppBusinessSolutionStatus·required Current effective status of the Multi-Partner Solution Show child attributes status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required Status of any pending solution status transition requests owner_appApplicationNode Meta application that owns the Multi-Partner Solution Show child attributes idstring Unique identifier for the Meta application namestring Name of the Meta application owner_permissionsarray of WhatsAppBusinessAccountPermissionTask List of WhatsApp Business Account permissions granted to the solution owner Show child attributes owner_permissions[]WhatsAppBusinessAccountPermissionTask Granular permission tasks for WhatsApp Business Account access 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or access denied Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution ID does not exist or is not accessible Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request parameters are valid but cannot be processed Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Business Multi-Partner Solutions - Solution Reject API | Developer Documentation WhatsApp Business Multi-Partner Solutions - Solution Reject API Copy for LLM View as Markdown Version API for rejecting Multi-Partner Solution partnership requests or deactivation requests. This endpoint allows solution partners to reject pending partnership requests or deactivation requests for Multi-Partner Solutions. POST /{Version}/{Solution-ID}/reject Reject a pending partnership request or deactivation request for a Multi-Partner Solution. This endpoint allows solution owners to decline incoming requests and maintain control over their solution partnerships and lifecycle. Use Cases: Reject partnership requests from unauthorized or incompatible applications Decline deactivation requests to keep solutions active Maintain solution security and partnership quality Control solution access and collaboration boundaries Request Types: PARTNERSHIP_REQUEST: Reject an incoming partnership request from another app DEACTIVATION_REQUEST: Reject a request to deactivate the solution Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Business Logic: Only solution owners can reject requests for their solutions Partnership rejections require the partner_app_id parameter Rejection actions are permanent and cannot be undone through this API Rejected requests may need to be resubmitted through proper channels Request Syntax Try it Select language Select status code Header Parameters User-Agentstring The user agent string identifying the client software making the request. Authorizationstring·required Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token. Path Parameters Versionstring·required Graph API version to use for this request. Determines the API behavior and available features. Solution-IDstring·required Your Multi-Partner Solution ID. This ID is provided when you create the solution and can be found in your Partner Dashboard or through solution management APIs. Required Content Type: application/json Schema: SolutionRejectRequest Show child attributes SolutionRejectRequest request_typeOne of "PARTNERSHIP_REQUEST", "DEACTIVATION_REQUEST"·required Type of request being rejected rejection_reasonstring Optional reason for rejecting the request partner_app_idstring The app ID of the requesting partner. Required when request_type is PARTNERSHIP_REQUEST, not used for DEACTIVATION_REQUEST Responses Reject a pending partnership request or deactivation request for a Multi-Partner Solution. This endpoint allows solution owners to decline incoming requests and maintain control over their solution partnerships and lifecycle. Use Cases: Reject partnership requests from unauthorized or incompatible applications Decline deactivation requests to keep solutions active Maintain solution security and partnership quality Control solution access and collaboration boundaries Request Types: PARTNERSHIP_REQUEST: Reject an incoming partnership request from another app DEACTIVATION_REQUEST: Reject a request to deactivate the solution Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Business Logic: Only solution owners can reject requests for their solutions Partnership rejections require the partner_app_id parameter Rejection actions are permanent and cannot be undone through this API Rejected requests may need to be resubmitted through proper channels 200 Successfully rejected the Multi-Partner Solution request Content Type: application/json Schema: SolutionRejectResponse Show child attributes SolutionRejectResponse successboolean·required Indicates whether the rejection was successful solution_idstring·required The ID of the Multi-Partner Solution rejected_request_typeOne of "PARTNERSHIP_REQUEST", "DEACTIVATION_REQUEST"·required Type of request that was rejected rejection_timestampstring (date-time) ISO 8601 timestamp when the rejection was processed partner_app_idstring App ID of the partner whose request was rejected (for partnership rejections) 400 Bad Request - Invalid parameters or malformed request Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 401 Unauthorized - Invalid or missing access token Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 403 Forbidden - Insufficient permissions or not solution owner Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 404 Not Found - Solution ID does not exist or request not found Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 422 Unprocessable Entity - Request cannot be processed due to business logic constraints Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 429 Too Many Requests - Rate limit exceeded Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes 500 Internal Server Error - Unexpected server error Content Type: application/json Schema: GraphAPIError Show child attributes GraphAPIError errorobject·required Show child attributes messagestring·required Human-readable error message typestring·required Error category type codeinteger·required Numeric error code error_subcodeinteger More specific error subcode when available fbtrace_idstring Unique identifier for debugging and support requests with Meta is_transientboolean Indicates whether this error is temporary and the request should be retried error_user_titlestring User-friendly error title for display purposes error_user_msgstring User-friendly error message for display purposes Select language Select status code Authentication Scheme Type Location bearerAuth HTTP Bearer Header: Authorization Usage Examples bearerAuth: Include Authorization: Bearer your-token-here in request headers Global Authentication Requirements All endpoints require: bearerAuth WhatsApp Cloud API - Phone Number API | Developer Documentation WhatsApp Cloud API - Phone Number APICopy for LLMView as MarkdownVersionWhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. Cloud API OverviewCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.https://developers.facebook.com/docs/whatsapp/cloud-api/overview Getting Started with Cloud APITo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API Get Started guide, these assets will be created for you. Get Started as a Solution PartnerThis guide goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers. Migrating from On-Premises API to Cloud APIThis guide explains how to migrate business phone numbers from On-Premises API to Cloud API. EnvironmentThis collection has a corresponding WhatsApp Cloud API Postman environment which you must select when using the collection. Set current values for the variables defined in this environment if you wish to use the collection to perform queries.You can find most of these values in the WhatsApp Manager or the WhatsApp > Getting Started panel in the app dashboard. However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values. Access tokensThe API supports both user and system user access tokens. You can get a user access token by loading your app in the app dashboard and navigating to the WhatsApp > Getting Started panel.Since user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See Access Tokens to learn how to create a system user and system user access token.Once you have your token, save it as a current value in the environment. Business portfolio IDYou can get your business portfolio ID by signing into the Meta Business Suite. The ID appears in the URL as the business_id query string parameter value. Once you save this as a current value in the environment, go to the WhatsApp Business Account (WABA) folder and run the Get all owned WABAs query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID. PermissionsThe API only relies on two permissions:whatsapp_business_managementwhatsapp_business_messagingNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.Queries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway. Access token debuggerYou can paste any token you generate into the access token debugger to see what type of token it is and what permission you have granted to your app. PaginationEndpoints that return lists/collections may paginate results (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned. WhatsApp Cloud API - Register API | Developer Documentation WhatsApp Cloud API - Register APICopy for LLMView as MarkdownVersionWhatsApp Cloud API, hosted by Meta, is the official WhatsApp Business Platform API used for business messaging. This collection contains common queries, sample responses, and links to supporting documentation that can help you quickly get started with the API. Cloud API OverviewCloud API allows medium and large businesses to communicate with customers at scale. Using the API, businesses can build systems that connect thousands of customers with agents or bots, enabling both programmatic and manual communication. Additionally, businesses can integrate the API with numerous backend systems, such as CRM and marketing platforms.https://developers.facebook.com/docs/whatsapp/cloud-api/overview Getting Started with Cloud APITo use the API and this collection you must have a Meta business portfolio, a WhatsApp Business Account, and a business phone number. If you complete the steps in the Cloud API Get Started guide, these assets will be created for you. Get Started as a Solution PartnerThis guide goes over the steps Solution Partners need to take in order to offer the Cloud API to their customers. Migrating from On-Premises API to Cloud APIThis guide explains how to migrate business phone numbers from On-Premises API to Cloud API. EnvironmentThis collection has a corresponding WhatsApp Cloud API Postman environment which you must select when using the collection. Set current values for the variables defined in this environment if you wish to use the collection to perform queries.You can find most of these values in the WhatsApp Manager or the WhatsApp > Getting Started panel in the app dashboard. However, if you have an access token and your business portfolio ID, you can use queries in the collection to get the remaining values. Access tokensThe API supports both user and system user access tokens. You can get a user access token by loading your app in the app dashboard and navigating to the WhatsApp > Getting Started panel. Alternatively you can use the Graph API Explorer to generate one.Since user access tokens expire after 24 hours, you'll likely want to generate a system user access token, which lasts up to 60 days (or permanently, if you wish). See Access Tokens to learn how to create a system user and system user access token.Once you have your token, save it as a current value in the environment. Business portfolio IDYou can get your business portfolio ID by signing into the Meta Business Suite. The ID appears in the URL as the business_id query string parameter value. Once you save this as a current value in the environment, go to the WhatsApp Business Account (WABA) folder and run the Get all owned WABAs query. This will return your WABA ID, which you can save to your environment and then use to determine your business phone number ID. PermissionsThe API only relies on two permissions:whatsapp_business_managementwhatsapp_business_messagingNote that if you get a user access token from the app dashboard, your app will automatically be granted these permissions (by you, on your behalf), so you can use the token to test right away.Queries that target your business portfolio require the business_management permission, which you may also need based on your business use case. Most developers do not need this permission, however, as accessing your business portfolio is uncommon, and the Meta Business Suite provides nearly all of this functionality anyway. Access token debuggerYou can paste any token you generate into the access token debugger to see what type of token it is and what permission you have granted to your app. PaginationEndpoints that return lists/collections may paginate results (you'll see previous and next properties in the response). Use the URLs from these properties to get the previous or next set of results. Note that if you click one of these links in Postman, it will open a new query in a new tab which you must save before running (otherwise it can't read your environment variables), so you may wish to cut and paste the URL and run the query in the same tab in which it was returned.