Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Phone Numbers

Retrieve a phone number profile

Retrieves a WhatsApp business phone number's profile. Customers can view your business profile by clicking your business's name or number in a conversation thread.

get/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format.

Response

Successfully retrieved the object.

aboutstring

The business's About text. This text appears in the business's profile, beneath its profile image, phone number, and contact buttons.

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 modified name

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.
addressstring

Address of the business. Character limit 256.

descriptionstring

Description of the business. Character limit 512.

emailstring

The contact email address (in valid email format) of the business. Character limit 128.

profilePictureUrlstring

URL of the profile picture used to upload to Meta.

vertical'OTHER' | 'AUTO' | 'BEAUTY' | 'APPAREL' | 'EDU' | 'ENTERTAIN' | 'EVENT_PLAN' | 'FINANCE' | 'GROCERY' | 'GOVT' | 'HOTEL' | 'HEALTH' | 'NONPROFIT' | 'PROF_SERVICES' | 'RETAIL' | 'TRAVEL' | 'RESTAURANT'

Industry of the WhatsApp phone number business profile. This can be either an empty string or one of the accepted values.

websitesstring[]

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 255 characters each.

Example response

{
  "about": "ABOUT",
  "verifiedName": "verifiedName",
  "newName": "John's Cake",
  "address": "ADDRESS",
  "description": "DESCRIPTION",
  "email": "tom@example.com",
  "profilePictureUrl": "https://URL",
  "vertical": "OTHER",
  "websites": [
    "https://WEBSITE-1"
  ]
}