# WhatsApp Business API - Phone Number Management API | Developer Documentation

<div id="bkmrk-whatsapp-business-ap"><div><div>## WhatsApp Business API - Phone Number Management API

<div><div><div><span>Copy for LLM</span></div></div><div>[<span>View as Markdown</span>](/books/meta-whatsapp/page/whatsapp-business-api-phone-number-management-api-developer-documentation)</div></div></div><div><div>Version</div></div><div><div><div><div><div><div><span><span>API for managing WhatsApp Business Account phone numbers, including retrieving phone number details</span></span></div></div><div><div><span><span>and creating new phone number registrations within a WhatsApp Business Account.</span></span></div></div></div></div></div></div></div><div><div>---

<div><div><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwaba"><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwaba-1"><div>### GET /{Version}/{WABA-ID}/phone\_numbers

</div></div></div><div><div><div><div><div><div><span><span>Retrieve all phone numbers associated with a WhatsApp Business Account, including their</span></span></div></div><div><div><span><span>status, verification details, and configuration information.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>List all phone numbers in a WhatsApp Business Account</span></span></div><div><span><span>Monitor phone number status and verification progress</span></span></div><div><span><span>Check phone number quality ratings and messaging limits</span></span></div><div><span><span>Retrieve phone number configuration details</span></span></div><div><div><span><span>Filtering:</span></span></div></div><div><div><span><span>You can filter results using the </span></span>`<span><span>filtering</span></span>`<span><span> parameter with JSON-encoded filter conditions.</span></span></div></div><div><div><span><span>Supported filters include account\_mode, messaging\_limit\_tier, and is\_official\_business\_account.</span></span></div></div><div><div><span><span>Sorting:</span></span></div></div><div><div><span><span>Results can be sorted by creation\_time or last\_onboarded\_time in ascending or descending order.</span></span></div></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Phone number data can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><span>Try it</span></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div><div><span>Header Parameters</span>---

<div><div><span>User-Agent</span><span>string</span></div><div><div><div><div><div><div><span><span>The user agent string identifying the client software making the request.</span></span></div></div></div></div></div></div></div><div><div><span>Authorization</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.</span></span></div></div></div></div></div></div></div></div><div><span>Path Parameters</span>---

<div><div><span>Version</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Graph API version to use for this request. Determines the API behavior and available features.</span></span></div></div></div></div></div></div></div><div><div><span>WABA-ID</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager</span></span></div></div><div><div><span><span>or through the business management APIs.</span></span></div></div></div></div></div></div></div></div><div><span>Query Parameters</span>---

<div><div><span>fields</span><span>string</span></div><div><div><div><div><div><div><span><span>Comma-separated list of fields to include in the response. If not specified,</span></span></div></div><div><div><span><span>default fields will be returned. Available fields include: id, display\_phone\_number,</span></span></div></div><div><div><span><span>verified\_name, status, quality\_rating, country\_code, country\_dial\_code,</span></span></div></div><div><div><span><span>code\_verification\_status, unified\_cert\_status, account\_mode, host\_platform,</span></span></div></div><div><div><span><span>messaging\_limit\_tier, is\_official\_business\_account, username</span></span></div></div></div></div></div></div></div><div><div><span>filtering</span><span>string</span></div><div><div><div><div><div><div><span><span>JSON-encoded array of filter conditions. Each filter should specify field, operator, and value.</span></span></div></div><div><div><span><span>Supported fields: account\_mode, messaging\_limit\_tier, is\_official\_business\_account</span></span></div></div></div></div></div></div></div><div><div><span>sort</span><span>One of "creation\_time.asc", "creation\_time.desc", "last\_onboarded\_time.asc", "last\_onboarded\_time.desc"</span></div><div><div><div><div><div><div><span><span>Sort field and direction. Format: field\_name.asc or field\_name.desc</span></span></div></div><div><div><span><span>Supported fields: creation\_time, last\_onboarded\_time</span></span></div></div></div></div></div></div></div><div><div><span>limit</span><span>integer \[min: 1, max: 100\]</span></div><div><div><div><div><div><div><span><span>Maximum number of phone numbers to return per page</span></span></div></div></div></div></div></div></div><div><div><span>after</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor for pagination - retrieve records after this cursor</span></span></div></div></div></div></div></div></div><div><div><span>before</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor for pagination - retrieve records before this cursor</span></span></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Retrieve all phone numbers associated with a WhatsApp Business Account, including their</span></span></div></div><div><div><span><span>status, verification details, and configuration information.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>List all phone numbers in a WhatsApp Business Account</span></span></div><div><span><span>Monitor phone number status and verification progress</span></span></div><div><span><span>Check phone number quality ratings and messaging limits</span></span></div><div><span><span>Retrieve phone number configuration details</span></span></div><div><div><span><span>Filtering:</span></span></div></div><div><div><span><span>You can filter results using the </span></span>`<span><span>filtering</span></span>`<span><span> parameter with JSON-encoded filter conditions.</span></span></div></div><div><div><span><span>Supported filters include account\_mode, messaging\_limit\_tier, and is\_official\_business\_account.</span></span></div></div><div><div><span><span>Sorting:</span></span></div></div><div><div><span><span>Results can be sorted by creation\_time or last\_onboarded\_time in ascending or descending order.</span></span></div></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Phone number data can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Successfully retrieved WhatsApp Business Account phone numbers</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>WhatsAppBusinessAccountPhoneNumbersConnection</span></div><div><div><div id="bkmrk-show-child-attribute"><div><span>Show child attributes</span></div></div><div id="bkmrk-whatsappbusinessacco"><div>---

<div><span>WhatsAppBusinessAccountPhoneNumbersConnection</span></div><div>---

<div><div><span>data</span><span>array of WhatsAppBusinessAccountPhoneNumber</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of phone number records</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-1"><div><span>Show child attributes</span></div></div><div id="bkmrk-data%5B%5Dwhatsappbusine"><div><div>---

<div><div><span>data\[\]</span><span>WhatsAppBusinessAccountPhoneNumber</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account phone number details and status information</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-2"><div><span>Show child attributes</span></div></div><div id="bkmrk-idstring%C2%B7requireduni"><div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the phone number status record</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>display\_phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Phone number in international format for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>verified\_name</span><span>string</span></div><div><div><div><div><div><div><span><span>Business name verified for this phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>status</span><span>WhatsAppPhoneNumberStatus</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Current status of the phone number in the WhatsApp Business Account</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>quality\_rating</span><span>WhatsAppPhoneNumberQualityRating</span></div><div><div><div><div><div><div><span><span>Quality rating for the phone number based on messaging patterns</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>country\_code</span><span>string</span></div><div><div><div><div><div><div><span><span>ISO 3166-1 alpha-2 country code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>country\_dial\_code</span><span>string</span></div><div><div><div><div><div><div><span><span>Country dialing code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code\_verification\_status</span><span>WhatsAppCodeVerificationStatus</span></div><div><div><div><div><div><div><span><span>Status of phone number verification code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>unified\_cert\_status</span><span>WhatsAppBusinessUnifiedCertStatus</span></div><div><div><div><div><div><div><span><span>Unified certification status combining business and name verification</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>account\_mode</span><span>WhatsAppBusinessSandboxEligibility</span></div><div><div><div><div><div><div><span><span>Account mode indicating sandbox or live environment eligibility</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>host\_platform</span><span>WhatsAppBusinessAccountHostPlatform</span></div><div><div><div><div><div><div><span><span>Platform hosting the WhatsApp Business Account</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>messaging\_limit\_tier</span><span>One of "TIER\_50", "TIER\_250", "TIER\_1K", "TIER\_10K", "TIER\_100K", "TIER\_UNLIMITED"</span></div><div><div><div><div><div><div><span><span>Current messaging limit tier for the phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_official\_business\_account</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Whether this is an official business account</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>username</span><span>string</span></div><div><div><div><div><div><div><span><span>WhatsApp username for the business account (if available)</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>paging</span><span>CursorPaging</span></div><div><div><div><div><div><div><span><span>Cursor-based pagination information</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-3"><div><span>Show child attributes</span></div></div><div id="bkmrk-cursorsobjectshow-ch"><div><div>---

<div><div><span>cursors</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-4"><div><span>Show child attributes</span></div></div><div id="bkmrk-beforestringcursor-p"><div><div>---

<div><div><span>before</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor pointing to the start of the page</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>after</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor pointing to the end of the page</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>previous</span><span>string</span></div><div><div><div><div><div><div><span><span>URL for the previous page of results</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>next</span><span>string</span></div><div><div><div><div><div><div><span><span>URL for the next page of results</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>400</span><div><div><div><div><div><div><span><span>Bad Request - Invalid parameters or malformed request</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-5"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-6"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>401</span><div><div><div><div><div><div><span><span>Unauthorized - Invalid or missing access token</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-7"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-1"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-8"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-1"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>403</span><div><div><div><div><div><div><span><span>Forbidden - Insufficient permissions or access denied</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-9"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-2"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-10"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-2"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>404</span><div><div><div><div><div><div><span><span>Not Found - WhatsApp Business Account ID does not exist or is not accessible</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-11"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-3"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-12"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-3"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>422</span><div><div><div><div><div><div><span><span>Unprocessable Entity - Request parameters are valid but cannot be processed</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-13"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-4"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-14"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-4"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>429</span><div><div><div><div><div><div><span><span>Too Many Requests - Rate limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-15"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-5"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-16"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-5"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>500</span><div><div><div><div><div><div><span><span>Internal Server Error - Unexpected server error</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-17"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-6"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-18"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-6"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div></div></div><div>---

<div><div><div id="bkmrk-post-%2F%7Bversion%7D%2F%7Bwab"><div id="bkmrk-post-%2F%7Bversion%7D%2F%7Bwab-1"><div>### POST /{Version}/{WABA-ID}/phone\_numbers

</div></div></div><div><div><div><div><div><div><span><span>Create a new phone number registration within a WhatsApp Business Account. This endpoint</span></span></div></div><div><div><span><span>initiates the phone number onboarding process, including verification and business name approval.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Add new phone numbers to a WhatsApp Business Account</span></span></div><div><span><span>Migrate phone numbers from on-premises to Cloud API</span></span></div><div><span><span>Register pre-verified phone numbers for BSP scenarios</span></span></div><div><span><span>Initiate phone number verification and business name approval process</span></span></div><div><div><span><span>Prerequisites:</span></span></div></div><div><span><span>WhatsApp Business Account must have available phone number slots</span></span></div><div><span><span>Phone number must not be already registered with WhatsApp Business</span></span></div><div><span><span>Business must meet WhatsApp Business API requirements</span></span></div><div><span><span>Appropriate permissions and app review completion</span></span></div><div><div><span><span>Process Flow:</span></span></div></div><div><span><span>Submit phone number and business name for registration</span></span></div><div><span><span>Phone number verification code will be sent (if not pre-verified)</span></span></div><div><span><span>Business name will be submitted for review</span></span></div><div><span><span>Monitor status through GET endpoint until approval</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Phone number creation is subject to strict rate limits to prevent abuse.</span></span></div></div><div><div><span><span>Standard Graph API rate limits also apply.</span></span></div></div><div><div><span><span>Migration Support:</span></span></div></div><div><div><span><span>Set migrate\_phone\_number=true when migrating from on-premises API to Cloud API.</span></span></div></div><div><div><span><span>Additional validation and migration-specific logic will be applied.</span></span></div></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><span>Try it</span></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div><div><span>Header Parameters</span>---

<div><div><span>User-Agent</span><span>string</span></div><div><div><div><div><div><div><span><span>The user agent string identifying the client software making the request.</span></span></div></div></div></div></div></div></div><div><div><span>Authorization</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.</span></span></div></div></div></div></div></div></div></div><div><span>Path Parameters</span>---

<div><div><span>Version</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Graph API version to use for this request. Determines the API behavior and available features.</span></span></div></div></div></div></div></div></div><div><div><span>WABA-ID</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account ID where the phone number will be added.</span></span></div></div><div><div><span><span>This ID can be found in your WhatsApp Manager or through business management APIs.</span></span></div></div></div></div></div></div></div></div><div><span>Required</span>---

<div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>PhoneNumberCreateRequest</span></div><div><div><div id="bkmrk-show-child-attribute-19"><div><span>Show child attributes</span></div></div><div id="bkmrk-phonenumbercreatereq"><div>---

<div><span>PhoneNumberCreateRequest</span></div><div>---

<div><div><span>phone\_number</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Phone number in E.164 format without the + prefix</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>verified\_name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Business name to be verified for this phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>cc</span><span>string</span></div><div><div><div><div><div><div><span><span>Country code for the phone number</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>migrate\_phone\_number</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Whether this is a phone number migration from on-premises</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>preverified\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Pre-verified phone number ID for BSP scenarios</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Create a new phone number registration within a WhatsApp Business Account. This endpoint</span></span></div></div><div><div><span><span>initiates the phone number onboarding process, including verification and business name approval.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Add new phone numbers to a WhatsApp Business Account</span></span></div><div><span><span>Migrate phone numbers from on-premises to Cloud API</span></span></div><div><span><span>Register pre-verified phone numbers for BSP scenarios</span></span></div><div><span><span>Initiate phone number verification and business name approval process</span></span></div><div><div><span><span>Prerequisites:</span></span></div></div><div><span><span>WhatsApp Business Account must have available phone number slots</span></span></div><div><span><span>Phone number must not be already registered with WhatsApp Business</span></span></div><div><span><span>Business must meet WhatsApp Business API requirements</span></span></div><div><span><span>Appropriate permissions and app review completion</span></span></div><div><div><span><span>Process Flow:</span></span></div></div><div><span><span>Submit phone number and business name for registration</span></span></div><div><span><span>Phone number verification code will be sent (if not pre-verified)</span></span></div><div><span><span>Business name will be submitted for review</span></span></div><div><span><span>Monitor status through GET endpoint until approval</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Phone number creation is subject to strict rate limits to prevent abuse.</span></span></div></div><div><div><span><span>Standard Graph API rate limits also apply.</span></span></div></div><div><div><span><span>Migration Support:</span></span></div></div><div><div><span><span>Set migrate\_phone\_number=true when migrating from on-premises API to Cloud API.</span></span></div></div><div><div><span><span>Additional validation and migration-specific logic will be applied.</span></span></div></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Successfully created phone number registration</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>PhoneNumberCreateResponse</span></div><div><div><div id="bkmrk-show-child-attribute-20"><div><span>Show child attributes</span></div></div><div id="bkmrk-phonenumbercreateres"><div>---

<div><span>PhoneNumberCreateResponse</span></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the created phone number status record</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>400</span><div><div><div><div><div><div><span><span>Bad Request - Invalid parameters or malformed request</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-21"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-7"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-22"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-7"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>401</span><div><div><div><div><div><div><span><span>Unauthorized - Invalid or missing access token</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-23"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-8"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-24"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-8"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>403</span><div><div><div><div><div><div><span><span>Forbidden - Insufficient permissions or phone number limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-25"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-9"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-26"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-9"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>404</span><div><div><div><div><div><div><span><span>Not Found - WhatsApp Business Account ID does not exist or is not accessible</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-27"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-10"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-28"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-10"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>409</span><div><div><div><div><div><div><span><span>Conflict - Phone number already exists or is in use</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-29"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-11"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-30"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-11"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>422</span><div><div><div><div><div><div><span><span>Unprocessable Entity - Request parameters are valid but cannot be processed</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-31"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-12"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-32"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-12"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>429</span><div><div><div><div><div><div><span><span>Too Many Requests - Rate limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-33"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-13"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-34"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-13"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>500</span><div><div><div><div><div><div><span><span>Internal Server Error - Unexpected server error</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-35"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-14"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-36"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-14"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div></div></div></div><div><div id="bkmrk-authentication"><div id="bkmrk-authentication-1"><div>### Authentication

</div></div></div><div><table><tbody><tr><td><div>**Scheme**</div></td><td><div>**Type**</div></td><td><div>**Location**</div></td></tr><tr><td><div><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>HTTP Bearer</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>Header: </span></span>`<span><span>Authorization</span></span>`</div></div></div></div></div></div></div></td></tr></tbody></table>

</div><div>#### Usage Examples

<div><span>bearerAuth:</span><div><div><div><div><div><div><span><span>Include </span></span>`<span><span>Authorization: Bearer your-token-here</span></span>`<span><span> in request headers</span></span></div></div></div></div></div></div></div></div><div>#### Global Authentication Requirements

<div><span>All endpoints require:</span><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></div></div></div>