# Number

HTML: https://www.app2email.com/docs/api/number · Index: https://www.app2email.com/docs/api/llms.txt

The number at WhatsApp: health, business profile, display name, username, QR codes, conversation starters, commerce.

| Method | Path | Summary | Scope | Sandbox key |
| --- | --- | --- | --- | --- |
| GET | `/v1/{number}/health` | [Number health: can it send, quality, limit, name status](https://www.app2email.com/docs/api/number/get-number-health.md) | `messages:read` | reads |
| PUT | `/v1/{number}/settings/identity-check` | [Turn WhatsApp's identity change check on or off](https://www.app2email.com/docs/api/number/set-identity-check.md) | `settings:manage` | refused |
| GET | `/v1/{number}/profile` | [The WhatsApp business profile](https://www.app2email.com/docs/api/number/get-business-profile.md) | `messages:read` | reads |
| PATCH | `/v1/{number}/profile` | [Change the WhatsApp business profile](https://www.app2email.com/docs/api/number/update-business-profile.md) | `settings:manage` | refused |
| PUT | `/v1/{number}/profile/photo` | [Change the profile photo from a public link](https://www.app2email.com/docs/api/number/set-profile-photo.md) | `settings:manage` | refused |
| PUT | `/v1/{number}/profile/display-name` | [Submit a new display name for Meta's review](https://www.app2email.com/docs/api/number/set-display-name.md) | `settings:manage` | refused |
| GET | `/v1/{number}/profile/official-business-account` | [Official Business Account (blue tick) status](https://www.app2email.com/docs/api/number/get-official-business-account.md) | `messages:read` | reads |
| POST | `/v1/{number}/profile/official-business-account` | [Request an Official Business Account (blue tick)](https://www.app2email.com/docs/api/number/request-official-business-account.md) | `settings:manage` | refused |
| GET | `/v1/{number}/profile/india-compliance` | [India business compliance information](https://www.app2email.com/docs/api/number/get-india-compliance.md) | `messages:read` | reads |
| PUT | `/v1/{number}/profile/india-compliance` | [Set the India business compliance information](https://www.app2email.com/docs/api/number/set-india-compliance.md) | `settings:manage` | refused |
| GET | `/v1/{number}/username` | [The business username](https://www.app2email.com/docs/api/number/get-username.md) | `messages:read` | reads |
| PUT | `/v1/{number}/username` | [Adopt or change the business username](https://www.app2email.com/docs/api/number/set-username.md) | `settings:manage` | refused |
| DELETE | `/v1/{number}/username` | [Remove the business username](https://www.app2email.com/docs/api/number/delete-username.md) | `settings:manage` | refused |
| GET | `/v1/{number}/username/suggestions` | [Usernames reserved for the business](https://www.app2email.com/docs/api/number/get-username-suggestions.md) | `messages:read` | reads |
| GET | `/v1/{number}/settings/conversation-starters` | [Ice breakers, commands and welcome message](https://www.app2email.com/docs/api/number/get-conversation-starters.md) | `messages:read` | reads |
| PUT | `/v1/{number}/settings/conversation-starters` | [Set ice breakers, commands or the welcome message](https://www.app2email.com/docs/api/number/set-conversation-starters.md) | `settings:manage` | refused |
| GET | `/v1/{number}/qr-codes` | [QR codes and short links](https://www.app2email.com/docs/api/number/list-qr-codes.md) | `messages:read` | reads |
| POST | `/v1/{number}/qr-codes` | [Create a QR code and wa.me short link](https://www.app2email.com/docs/api/number/create-qr-code.md) | `settings:manage` | refused |
| GET | `/v1/{number}/qr-codes/{code}` | [One QR code](https://www.app2email.com/docs/api/number/get-qr-code.md) | `messages:read` | reads |
| PATCH | `/v1/{number}/qr-codes/{code}` | [Change a QR code's prefilled message](https://www.app2email.com/docs/api/number/update-qr-code.md) | `settings:manage` | refused |
| DELETE | `/v1/{number}/qr-codes/{code}` | [Delete a QR code and its short link](https://www.app2email.com/docs/api/number/delete-qr-code.md) | `settings:manage` | refused |
| GET | `/v1/{number}/settings/commerce` | [Cart and catalog icon on or off](https://www.app2email.com/docs/api/number/get-commerce-settings.md) | `messages:read` | reads |
| PUT | `/v1/{number}/settings/commerce` | [Turn the cart or the catalog icon on or off](https://www.app2email.com/docs/api/number/set-commerce-settings.md) | `settings:manage` | refused |
| GET | `/v1/{number}/catalog` | [The connected product catalog](https://www.app2email.com/docs/api/number/get-catalog.md) | `messages:read` | reads |
| PUT | `/v1/{number}/catalog` | [Connect a product catalog](https://www.app2email.com/docs/api/number/connect-catalog.md) | `settings:manage` | refused |
