Skip to main content
PATCH
/
v1
/
whatsapp
/
phone-numbers
/
{phoneNumberId}
/
settings
cURL
curl --request PATCH \
  --url https://api.buildwithchirp.com/v1/whatsapp/phone-numbers/{phoneNumberId}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calling": {
    "status": "enabled",
    "callIconVisibility": "visible",
    "video": {
      "status": "enabled"
    }
  },
  "userIdentityChange": {
    "enableIdentityKeyCheck": true
  },
  "payloadEncryption": {
    "status": "enabled"
  },
  "storageConfiguration": {
    "status": "default",
    "dataLocalizationRegion": "<string>"
  }
}
'
{
  "success": true
}

Authorizations

Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

phoneNumberId
string
required

WhatsApp phone number ID (internal Chirp ID)

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
calling
object

Calling settings to update

userIdentityChange
object

User identity change settings to update

payloadEncryption
object

Payload encryption settings to update

storageConfiguration
object

Storage configuration settings to update

Response

Phone settings updated successfully

success
enum<boolean>
required
Available options:
true,
false