Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Phone Numbers

Delete a Meta contact book entry

Deletes the Meta contact book entry that associates a WhatsApp business phone number with a customer's WhatsApp Business-scoped user ID (BSUID).

Only standard BSUIDs such as US.11815799212886844830 are supported. Parent BSUIDs such as US.ENT.11815799212886844830 are not supported. The BSUID must be scoped to the same Meta business portfolio as the phone number. The specified WABA must belong to the authenticated YCloud account and be available, and the phone number must be bound to that WABA in YCloud. Use the YCloud account API key in the X-API-Key header. Developer App API keys are not supported and return HTTP 403.

An HTTP 200 response always has success=true. deleted=true means Meta reports that it deleted a matching contact book entry. deleted=false means Meta processed the request but found no matching entry to delete. This operation does not delete or modify YCloud Contact, message, or BSUID business records, and it does not bypass Meta's 30-day caching behavior. A later WhatsApp interaction between the same business phone number and customer may cause Meta to create the entry again.

delete/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/contactBook/{bsuid}

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format, bound to the specified WABA in YCloud. When constructing the path manually, URL-encode the leading + as %2B.

bsuidstring required
Example:US.11815799212886844830

Standard WhatsApp Business-scoped user ID (BSUID) from the same Meta business portfolio as the phone number. Parent BSUIDs containing .ENT. are not supported.

Response

The delete request was processed successfully.

successboolean required

Always true in an HTTP 200 response.

deletedboolean required

Meta's deletion result. true means Meta reports that it deleted a matching entry. false means Meta processed the request but found no matching entry to delete.

Example response

{
  "success": true,
  "deleted": true
}