bird whatsapp numbers profile update

Usage

Code example

bird whatsapp numbers profile update <number-id> [flags]

Description

Update a WhatsApp number's business profile

Change the business profile WhatsApp shows to people a connected number messages. username_transfer_action: force_transfer takes the username off another of the workspace's numbers and the response does not say which, so confirm with a person before sending it.

Build the request from flags, a JSON WhatsAppNumberProfileUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird whatsapp numbers profile update --example

# the body it prints:

Code example

{
  "about": "Open Monday to Friday, 9am to 6pm CET.",
  "display_name": "Lucky Shrub Garden Center",
  "websites": ["https://bird.com"]
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--display-name	The name shown at the top of a chat with this number. The change is not immediate. The requested name is returned as new_display_name and its progress as new_display_name_status, while display_name still returns the current name until the change completes. A requested change cannot be withdrawn, so wait for WhatsApp's verdict rather than sending a second one. What happens to the name you send: - Leading and trailing spaces are removed, and the 75-character limit is measured on the value you send, before they are. - A name that is empty or only spaces returns a validation error. - A name that breaks WhatsApp's display name guidelines is refused by WhatsApp itself. - Sending the name the number already has changes nothing, and leaves a change in progress untouched. Omit this to leave the name as it is; there is no value that removes it. What a rename costs, and which numbers cannot be renamed over this API, is on the operation itself.
--about	The short line shown under the business name in a chat. Cannot be cleared because WhatsApp requires at least one character.
--address	The business address shown on the profile.
--description	The longer description shown on the profile.
--email	The contact email shown on the profile.
--vertical	The industry WhatsApp shows on the business profile. WhatsApp adds categories over time, so a value outside this list can be returned. Known values: other, auto, beauty, apparel, edu, entertain, event_plan, finance, grocery, govt, hotel, health, nonprofit, prof_services, retail, travel, restaurant, alcohol, online_gambling, physical_gambling, otc_drugs (others may exist).
--websites <value>…	Up to two websites, each a full address starting with http:// or https://.
--profile-picture-url	The URL of a file in your workspace's media library, which becomes the profile picture WhatsApp shows for this number. A URL from anywhere else is refused. JPEG or PNG up to 5 MB; WhatsApp crops the picture to a circle, so a square image renders best. Omit this to keep the current picture. The profile returns WhatsApp's copy at a different URL.
--username	The username WhatsApp users can find this number by, without an @. Letters, digits, periods and underscores only, 3 to 35 characters, with at least one letter, and it may not start or end with a period. Comparison ignores case, so MyID and myid are the same username, while my.id and my_id are different ones. A username is unique across all of WhatsApp, so one already in use is refused. Omit this to leave the current username as it is; there is no value that removes it.
--username-transfer-action	What to do when the username you are asking for is already in use by another of your own WhatsApp numbers. none leaves it where it is and the request is refused; force_transfer moves it to this number, removing it from the other one. Only usernames on numbers in the same WhatsApp business portfolio can be transferred. Only applies when username is also being set in the same request; it is ignored otherwise. The response to a forced transfer describes only the number you called it on. It never names the number that lost the username, so restoring that number's username means knowing which one it was beforehand. Possible values: none, force_transfer.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird whatsapp numbers profile get	Get a WhatsApp number's business profile

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideConnecting WhatsApp to Bird: from buying a number to a live channel Understand the conceptWhat is the 24-hour customer service window on WhatsApp?Explore the capabilityWhatsApp Follow the learning pathBuild your first integration

Try the practice and get an implementation brief