Resumable Upload Create An Upload Session

The Resumable Upload series of requests allow you to upload Profile Pictures to Meta so you can receive a handle to update these pictures in the Business Profile API. The Resumable Upload requests consist of the following: * **Resumable Upload - Create an Upload Session** * **Resumable Upload - Upload File Data** * **Resumable Upload - Query File Upload Status** To create a new upload session, make a **POST** call using the `/app/uploads` endpoint. For more information, see [Create an Upload Session](https://developers.facebook.com/docs/graph-api/guides/upload#step-1--create-a-session). **Response** The call returns a server-generated value that includes the session ID that you can use in later calls. >Copy this value and Open the **Environment quick look** in Postman and paste it in the **CURRENT VALUE** for `Upload-ID`.

Get Shared Waba Id

Get Shared WABA ID

Get List Of Shared Wabas

Get List of Shared WABAs

Retrieve Media Url

To retrieve your media’s URL, make a **GET** call to **`/`**. Use the returned URL to download the media file. Note that clicking this URL (i.e. performing a generic GET) will not return the media; you must include an access token. For more information, see [Download Media](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#download-media). You can also use the optional query **`?phone_number_id`** for **`Retrieve Media URL`** and **`Delete Media`**. This parameter checks to make sure the media belongs to the phone number before retrieval or deletion. #### Response A successful response includes an object with a media URL. The URL is only valid for 5 minutes. To use this URL, see [Download Media](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#download-media).

Delete Media

To delete media, make a **DELETE** call to the ID of the media you want to delete. ## Prerequisites - [User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with **`whatsapp_business_messaging`** permission - Media object ID from either uploading media endpoint or media message Webhooks ## Request [Perform requests in Graph API Explorer](https://developers.facebook.com/tools/explorer/?method=DELETE&path=media_id&version=v8.0)

Download Media

When you retrieve a media URL through the **GET** Media endpoint, you must use a User Access Token to download media content from the URL. If you click the URL from a browser, you will get an access error. > **Note**: all media URLs will expire after 5 minutes, you need to retrieve the media URL again if it expires. ## Prerequisites - [User Access Token](https://developers.facebook.com/docs/facebook-login/access-tokens#usertokens) with **`whatsapp_business_messaging`** permission - A media URL obtained from retrieving media url endpoint ## Response: If successful, you receive the binary data of media saved in **`media_file`**, response headers contain a `content-type` header to indicate the mime type of returned data. For more information, see [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). If media fails to download, you receive a **404 Not Found** response code. In that case, we recommend that you try to [Retrieve Media URL](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#retrieve-media-url) and download again. If doing so doesn't resolve the issue, please try to renew the **`USER_ACCESS_TOKEN`** then retry downloading the media.

Get Display Name Status Beta

Include **`fields=name_status`** as a query string parameter to get the status of a display name associated with a specific phone number. This field is currently in beta and not available to all developers.

Set Two Step Verification Code

You can use this endpoint to change two-step verification code associated with your account. After you change the verification code, future requests like changing the name, must use the new code. **You set up two-factor verification and [register a phone number](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/registration#register-phone) in the same API call.** You must use the parameters listed below to change two-step verification ## Parameters | Name | Description | |-------------- |--------------- | | **`pin`** | **Required**. A 6-digit PIN you want to use for two-step verification. |

Get Blocked Users

- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users) - Endpoint reference: [GET WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Reading)

Block Users

- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users) - Endpoint reference: [POST WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Creating)

Unblock Users

- Guide: [Block Users](https://developers.facebook.com/docs/whatsapp/cloud-api/block-users) - Endpoint reference: [DELETE WhatsApp Buiness Phone Number > block_users](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/#Deleting)

Get India Based Business Compliance Info

Get India-based business compliance info

Add India Based Business Compliance Info

Add India-based business compliance info

Deregister Phone

To deregister your phone, make a **POST** call to **`/deregister`**. **Deregister Phone** removes a previously registered phone. You can always re-register your phone using by repeating the registration process. #### Response A successful response returns: ``` json { "success": true } ```

Upload Audio

This request uploads an audio as .ogg. The parameters are specified as **form-data** in the request **body**.

Send Sample Issue Resolution Template

Mark Message As Read

When you receive an incoming message from Webhooks, you could use messages endpoint to change the status of it to read. We recommend marking incoming messages as read within 30 days of receipt. **Note**: you cannot mark outgoing messages you sent as read. You need to obtain the **`message_id`** of the incoming message from Webhooks. For a more in depth guide for marking messages as read, see [Guide: Mark Messages as Read](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/mark-message-as-read).

Register Phone

To register your phone, make a **POST** call to **`//register`**. You need to include the following parameters. ## Request Parameters | Name | Description | |-------------------------|--------------------------| | **`messaging_product`** | **Required**. The messaging service used. This value always needs to be set to `"whatsapp"`. | | **`pin`** | **Required**. A 6-digit pin you previously set up. For more information, see [Set Two-Step Verification](#08c441cc-8837-4ce5-8e0d-73fb0125c323). |

Request Verification Code

You need to verify the phone number you want to use to send messages to your customers. Phone numbers must be verified through SMS/voice call. The verification process can be done through the Graph API calls specified below. To verify a phone number using Graph API, make a **POST** request to **`/request_code`**. In your call, include your chosen verification method and language. You need to authenticate yourself using **** (This is automatically done for you in the **`Request Verification Code`** request). #### Request Parameters | Name | Description | |-----------------------|-----------------------------| | **`code_method`** | **Required**. Specifies the method for verification. Supported options are: `SMS` or `VOICE`. | | **`language`** | **Required**. Specifies your language. For instance: `"en_US"`. | #### Response After a successful call to **`Request Verification Code`**, you will receive your verification code via the method you selected in **`code_method`**. To finish the verification process, you need to use the [**`Verify Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify) request.

Verify Code

After you received a SMS or Voice request code from [**`Request Verification Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify), you need to verify the code that was sent to you. To verify this code, make a **POST** request to **`/verify_code`** that includes the code as a parameter. #### Request Parameters | Name | Description | |-----------------------|-----------------------------| | **`code`** type: Numeric String | **Required**. The code you received after calling [**`Request Verification Code`**](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#verify)(**`/request_code`**). |

Get Business Profile

To get information about a business profile, make a **GET** call to the **`//whatsapp_business_profile`** endpoint. Within the **`whatsapp_business_profile`** request, you can specify what you want to know from the business. ## Fields | Name | Description | |-------------------------|--------------------------------------| | **`messaging_product`** | **Required**. The messaging service used for the request. Always set the value to `"whatsapp"` if you are using WhatsApp for Business API.| | **`address`** | The address of the business. The maximum character limit for the string is 256. | | **`description`** |Description of the business. The maximum character limit for the string is 256. | | **`vertical`** | **Optional**. The industry type of the business. This can be either an empty string or one of the accepted values **Values**: `UNDEFINED`, `OTHER`, `AUTO`, `BEAUTY`, `APPAREL`, `EDU`, `ENTERTAIN`, `EVENT_PLAN`, `FINANCE`, `GROCERY`, `GOVT`, `HOTEL`, `HEALTH`, `NONPROFIT`, `PROF_SERVICES`, `RETAIL`, `TRAVEL`, `RESTAURANT`, or `NOT_A_BIZ`.| | **`about`** | **Optional**. The text to display in business profile's About section The max length for the string is 139 characters. The minimum length for the string is 1 character. Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.| | **`email`** | **Optional**. The contact email address (in valid email format) of the business. The maximum character limit for the string is 128 characters.| | **`websites`** | **Optional**. The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 256 characters each. | | **`profile_picture_handle`** | **Optional**. The handle of the profile picture generated from a call to the [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload).|

Update Business Profile

Update the business profile information such as the business description, email or address. To update your profile, make a **POST** call to **`//whatsapp_business_profile`**. In your request, you can include the parameters listed below. It is recommended that you use **Resumable Upload - Create an Upload Session** to obtain an upload ID. Then use this upload ID in a call to **Resumable Upload - Upload File Data** to obtain the picture handle. This handle can be used for the **`profile_picture_handle`**. ## Request Parameters | Name | Description | |-------------------------|--------------------------------------| | **`messaging_product`** | **Required**. The messaging service used for the request. Always set the value to `"whatsapp"` if you are using WhatsApp for Business API.| | **`address`** | **Optional**. The address of the business. The maximum character limit for the string is 256. | | **`description`** | **Optional**. The description of the business. The maximum character limit for the string is 256. | | **`vertical`** | **Optional**. The industry type of the business. This can be either an empty string or one of the accepted values. **Values**: `UNDEFINED`, `OTHER`, `AUTO`, `BEAUTY`, `APPAREL`, `EDU`, `ENTERTAIN`, `EVENT_PLAN`, `FINANCE`, `GROCERY`, `GOVT`, `HOTEL`, `HEALTH`, `NONPROFIT`, `PROF_SERVICES`, `RETAIL`, `TRAVEL`, `RESTAURANT`, or `NOT_A_BIZ`.| | **`about`** | **Optional**. The text to display in business profile's About section. The max length for the string is 139 characters. The minimum length for the string is 1 character. Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.| | **`email`** | **Optional**. The contact email address (in valid email format) of the business. The maximum character limit for the string is 128 characters.| | **`websites`** | **Optional**. The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 256 characters each. | | **`profile_picture_handle`** | **Optional**. The handle of the profile picture generated from a call to **Resumable Upload - Upload File Data**. For more information, see [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload).| ## Delete Business Profile To delete your business profile, you must [delete your phone number](https://developers.facebook.com/docs/whatsapp/phone-numbers#delete-phone-number-from-a-business-account).

Resumable Upload Query File Upload Status

You can query the status of an upload session by making a **GET** call to an endpoint that is named based on the **`Upload-ID`** that was returned through the **Resumable Upload - Create an Upload Session** request. When uploading data, you **must include the access token as an HTTP header.** **Example** ``` bash GET https://graph.facebook.com/v14.0/upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI HTTP/1.1 Authorization: OAuth ``` For more information, see [Query File Upload Status after an Interruption](https://developers.facebook.com/docs/graph-api/guides/upload#interruptions). **Response** The result will be a JSON-encoded ID and offset that looks like the following: ``` json { "id": "upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI", "file_offset": 0 } ```

Resumable Upload Upload File Data

To upload a profile picture to your business profile, make a **POST** call to the named endpoint /, where **Upload-ID** is the value you received from **Resumable Upload - Create an Upload Session**. This value should look like the following: ``` json "upload:MTphdHRhY2htZW50Ojlk2mJiZxUwLWV6MDUtNDIwMy05yTA3LWQ4ZDPmZGFkNTM0NT8=?sig=ARZqkGCA_uQMxC8nHKI" ``` The **`file_offset`** parameter **must** be included as an HTTP header. It will not work as a query parameter. The access token must be included in an Authorization HTTP header. It cannot work as a query parameter. For more information, see [Initiate Data Upload](https://developers.facebook.com/docs/graph-api/guides/upload#step-2--initiate-upload). **Response** The call returns a handle that includes the session ID that you can use to update your profile picture using **Update Business Profile**.

Get Phone Numbers

This API returns all phone numbers in a WhatsApp Business Account specified by the **``** value. Get the **`id`** value for the phone number you want to use to send messages with WhatsApp Business Cloud API. #### Response Parameters | Name | Description | |-----------------------|-----------------------------| | **`verified_name`** | The verified name associated with the phone number. | | **`display_phone_number`** | The string representation of the phone number. | | **`id`** | The ID associated with the phone number. | | **`quality_rating`** | The quality rating of the phone number based on how messages have been received by recipients in recent days. Valid values are: <ul><li>**`Green`**: High Quality</li><li>**`Yellow`**: Medium Quality</li><li>**`Red`**: Low Quality</li><li>**`NA`**: Quality has not been determined</li></ul> For more information relating to quality rating, see [About WhatsApp Business Account Message Quality Rating](https://www.facebook.com/business/help/896873687365001). |

Get All Subscriptions For A Waba

To get a list of apps subscribed to Webhooks for a WABA, send a **GET** request to the **`subscribed_apps`** endpoint on the WABA:

Override Callback Url

If you want to subscribe to Webhooks for multiple WhatsApp Business Accounts but want messages field Webhooks notifications to be sent to different callback URLs for each WABA, you can override the callback URL when subscribing to Webhooks for each WABA. To do this, first verify that the alternate Webhook endpoint can receive and process Webhooks notifications. Then, subscribe to Webhooks for the WABA as your normally would, but include the alternate endpoint's callback URL along with its verification token as a JSON payload: For more information, see [Overriding the Callback URL](https://developers.facebook.com/docs/whatsapp/embedded-signup/webhooks#overriding-the-callback-url).

Unsubscribe From A Waba

To unsubscribe your app from webhooks for a WhatsApp Business Account, send a **DELETE** request to the `/subscribed_apps/` endpoint on the WABA.

Upload media (Step 1 of 2): Create session

- Guide: [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload) - Endpoint reference: [Application > Uploads](https://developers.facebook.com/docs/graph-api/reference/application/uploads/)

Get business account (specific fields)

Endpoint reference: [Business](https://developers.facebook.com/docs/marketing-api/reference/business/)

Get all shared WABAs

Endpoint reference: [Business > Extended Credits](https://developers.facebook.com/docs/marketing-api/reference/business/extendedcredits/)

Get credit lines

- Endpoint reference: [Business > Extendedcredits](https://developers.facebook.com/docs/marketing-api/reference/extended-credit/)

Get all owned WABAs

Endpoint reference: [Business > Extended Credits](https://developers.facebook.com/docs/marketing-api/reference/business/extendedcredits/)

Get analytics for a WABA

Fetches analytics for the specified WhatsApp Business Account (WABA), with support for filtering by date range, granularity, conversation directions, and dimensions.

Get business phone number display name status (beta)

- Guide: [Get Display Name Status (Beta)](https://developers.facebook.com/docs/whatsapp/business-management-api/manage-phone-numbers#get-display-name-status--beta-) - Endpoint reference: [WhatsApp Business Phone Number](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/)

Get QR code PNG image URL

- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes) - Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)

Update Message QR Code.

- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes) - Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)

Get QR code

- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes) - Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)

Delete QR code

- Guide: [QR Codes](https://developers.facebook.com/docs/whatsapp/business-management-api/qr-codes) - Endpoint reference: [WhatsApp Business Phone Number > Message Qrdls](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/message_qrdls/)

Get commerce settings

- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services) (Cloud API) - Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides) (On-Premises API) - Endpoint reference: [WhatsApp Business Phone Number > WhatsApp Commerce Settings](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings)

Set or update commerce settings

- Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services) (Cloud API) - Guide: [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides) (On-Premises API) - Endpoint reference: [WhatsApp Business Phone Number > WhatsApp Commerce Settings](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings)

Upload media (Step 2 of 2): Initiate upload

- Guide: [Resumable Upload API](https://developers.facebook.com/docs/graph-api/guides/upload)

Get template by ID (default fields)

- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates) - Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals) - Endpoint reference: [WhatsApp Message Template](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/)

Edit template

- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates) - Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals) - Endpoint reference: [WhatsApp Message Template](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/)

Get WABA

- Endpoint reference: [WhatsApp Business Account](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account)

Get all templates (default fields)

- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates) - Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals) - Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)

Create template w/ document header, text body, a phone number button, and a URL button

- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates) - Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals) - Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)

Delete template by ID

- Guide: [Message Templates](https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates) - Guide: [How To Monitor Quality Signals](https://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals) - Endpoint reference: [WhatsApp Business Account > Message Templates](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/)

Get all business phone numbers w/ filtering (beta)

- Guide: [Filter Phone Numbers](https://developers.facebook.com/docs/whatsapp/business-management-api/manage-phone-numbers#filter-phone-numbers) - Endpoint reference: [WhatsApp Business Account > Phone Numbers](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/phone_numbers/)

Get all apps subscribed to WABA's webhooks

- Guide: [Webhooks](https://developers.facebook.com/docs/whatsapp/business-management-api/guides/set-up-webhooks) - Endpoint reference: [WhatsApp Business Account > Subscribed Apps](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/subscribed_apps)

Subscribe app to WABA's webhooks

- Guide: [Webhooks](https://developers.facebook.com/docs/whatsapp/business-management-api/guides/set-up-webhooks) - Endpoint reference: [WhatsApp Business Account > Subscribed Apps](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/subscribed_apps)

Unsubscribe app from WABA's webhooks

- Guide: [Webhooks](https://developers.facebook.com/docs/whatsapp/business-management-api/guides/set-up-webhooks) - Endpoint reference: [WhatsApp Business Account > Subscribed Apps](https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/subscribed_apps)

Send Flow Template Message

Register Phone Number

Register a phone number to send messages. The pin is a 6 digit number of you choice

Get Encryption Public Key

Set Encryption Public Key

Sets the public key that is used for encrypting the data channel requests

Get Endpoint Availability Metric

Can request specific fields by enabling the \`fields\` query param

Update Flow Metadata

Delete Flow

Deletes the flow entirely. This action is not reversible. Only a DRAFT flow can be deleted.

List Assets (Get Flow JSON URL)

Returns all assets attached to the flow. Currently only FLOW_JSON asset is supported

Update Flow JSON

Used to upload a flow JSON file with the flow content. Refer to flow JSON documentation here [https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson](https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson) The file must be attached as from data. The response will include any validation errors in the JSON file

Deprecate Flow

Updates the status of the flow as "DEPRECATED". This action is not reversible. Only a published flow can be deprecated to prevent sending or opening it.

Publish Flow

Updates the status of the flow as "PUBLISHED". This action is not reversible. The flow and its assets become immutable once published. To update the flow, you must create a new flow and specify the previous flow id as the \`clone_flow_id\` parameter

Get WABA

Get the WhatsApp Business Account details to verify API setup

List Flows

Create Flow

Creates a new flow. To clone an existing flow you can add the parameter `"clone_flow_id": "original-flow-id"`

Create Flow Template Message by ID

Migrate Flows

Creates a copy of existing flows from source WABA to destination WABA with the same names.

Get WABA Phone Numbers

Gets the phone numbers linked to the WABA