Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Phone Numbers

Update a phone number display name

Updates a WhatsApp business phone number display name.

patch/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/displayName

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format.

Request body

newNamestring

The new name you want to modify

Example request

{
  "newName": "newName"
}

Response

Successfully updated the object.

verifiedNamestring

The verified name

nameStatus'APPROVED' | 'AVAILABLE_WITHOUT_REVIEW' | 'DECLINED' | 'EXPIRED' | 'PENDING_REVIEW' | 'NONE'

The review status of the current display name request. See also Get Display Name Status.

  • APPROVED: The name has been approved. You can download your certificate now.
  • AVAILABLE_WITHOUT_REVIEW: The certificate for the phone is available and display name is ready to use without review.
  • DECLINED: The name has not been approved. You cannot download your certificate.
  • EXPIRED: Your certificate has expire and can no longer be downloaded.
  • PENDING_REVIEW: Your name request is under review. You cannot download your certificate.
  • NONE: No certificate is available.
newNamestring

The new name you want to modify

newNameStatus'APPROVED' | 'AVAILABLE_WITHOUT_REVIEW' | 'DECLINED' | 'EXPIRED' | 'PENDING_REVIEW' | 'NONE'

The review status of the current display name request. See also Get Display Name Status.

  • APPROVED: The name has been approved. You can download your certificate now.
  • AVAILABLE_WITHOUT_REVIEW: The certificate for the phone is available and display name is ready to use without review.
  • DECLINED: The name has not been approved. You cannot download your certificate.
  • EXPIRED: Your certificate has expire and can no longer be downloaded.
  • PENDING_REVIEW: Your name request is under review. You cannot download your certificate.
  • NONE: No certificate is available.

Example response

{
  "verifiedName": "verifiedName",
  "newName": "newName"
}