whatsapp-numbers

Get a WhatsApp number's business profile

Returns the business profile WhatsApp shows to people this number messages, read from WhatsApp on each request rather than from a stored copy. Readable for a number your workspace connected itself and for one Bird operates on your behalf alike, since the profile is what everyone the number messages already sees; only the first can be changed. The response includes the display name WhatsApp shows for this number and the state of its review.

get/v1/whatsapp/numbers/{number_id}/profile

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/whatsapp/numbers/{number_id}/profile
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

number_idstring required
Example:wan_01krdgeqcxet5s7t44vh8rt9mg

ID of the WhatsApp number (wan_ prefix), as returned by the number list.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The number's business profile.

display_namestring

The name WhatsApp verifies for this number. Once WhatsApp approves it, it appears at the top of a chat with this number; display_name_status is what says whether it has. Set when the number was connected, and changed from the dashboard or the CLI, as WhatsApp phone numbers explains. This field still returns the current name until a requested change completes.

display_name_statusstring

Where WhatsApp's review of the display name stands. available_without_review means the name met WhatsApp's criteria for immediate use without a review step, and none means no display name has been submitted yet. WhatsApp adds states over time, so a value outside this list can be returned.

new_display_namestring

The display name whose change has been requested, whether or not WhatsApp is reviewing it. Absent when no change is pending.

new_display_name_statusstring

Where WhatsApp's review of the display name stands. available_without_review means the name met WhatsApp's criteria for immediate use without a review step, and none means no display name has been submitted yet. WhatsApp adds states over time, so a value outside this list can be returned.

usernamestring

The username WhatsApp users can find this number by, without an @. Absent when the number has no username. Once set it cannot be removed through this API.

username_statusstring

Where the username stands with WhatsApp. WhatsApp adds states over time, so a value outside this list can be returned.

aboutstring

The short line shown under the business name in a chat.

addressstring

The business address shown on the profile.

descriptionstring

The longer description shown on the profile.

emailstring email

The contact email shown on the profile.

verticalstring

The industry WhatsApp shows on the business profile. WhatsApp adds categories over time, so a value outside this list can be returned.

websitesstring[]

Up to two websites shown on the profile.

profile_picture_urlstring

A link to the profile picture WhatsApp currently shows. WhatsApp signs this link and it expires within days, so load it when you display it and never store it. It is served with permissive cross-origin headers, so a browser can load it directly.

Example response

{
  "display_name": "Lucky Shrub",
  "display_name_status": "approved",
  "new_display_name": "Lucky Shrub Garden Center",
  "new_display_name_status": "approved",
  "username": "goldcrest.support",
  "username_status": "approved",
  "about": "Open Monday to Friday, 9am to 6pm CET.",
  "address": "Trompenburgstraat 2C, 1079 TX Amsterdam",
  "description": "Bird is the platform for messaging with your customers.",
  "email": "hello@bird.com",
  "vertical": "retail",
  "websites": [
    "https://bird.com"
  ],
  "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/643148303_1005107588793925.jpg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.