Graph API Version

Whats App Business Phone Number Register

Reading

You can't perform this operation on this endpoint.

Creating

Register a business phone number for use with WhatsApp Cloud API. See Registering Phone Numbers for additional information about registering business phone numbers programmatically.

You can make a POST request to register edge from the following paths:

/{whats_app_business_phone_number_id}/register

When posting to this edge, no Graph object will be created.

Requirements

Type	Description
Access Tokens	User or System User
Permissions	whatsapp_business_management

Request Syntax

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/register

Post Body

{
  "messaging_product": "whatsapp",
  "pin": "<TWO_STEP_VERIFICATION_PIN>",
  "data_localization_region": "<LOCAL_STORAGE_COUNTRY>", // Only if enabling local storage
  "backup": "<BACKUP_DATA>" // Only if migrating from On-Premises API to Cloud API
}

Example Request

curl 'https://graph.facebook.com/v21.0/110200345501442/register' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "123456"
}'

Example Response

{
  "success": true
}

Parameters

Parameter	Description
`backup` JSON object	Business phone number migration backup data. See Migrating from On-Premises API to Cloud API.
`password` string	password
`data` string	data
`messaging_product` enum {WHATSAPP}	Messaging product. Set to `WHATSAPP`. Required
`pin` string	Business phone number two-step verification PIN. Required

Return Type

Struct {

success: bool,

}

Error Codes

Error	Description
133016	Registration or Deregistration failed because there were too many attempts for this phone number in a short period of time
100	Invalid parameter
131000	Something went wrong
131031	Business Account locked
133005	Two step verification PIN Mismatch
133006	Phone number re-verification needed
133010	The account is not registered
133015	Please wait a few minutes before attempting to register this phone number
200	Permissions error
133009	Two step verification PIN Guessed Too Fast

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.