`bird whatsapp agents business-info update`

Usage

Code example

bird whatsapp agents business-info update <number-id> [flags]

Description

Update what a WhatsApp agent knows about the business

Change what the agent knows about the business. Send only the fields to change; omitted fields are left alone, and a null field is cleared, except under contact_info, which WhatsApp keeps until a new value replaces it. Bird merges the change into what WhatsApp holds and writes the whole object there before this returns, and it takes effect on the next conversation turn.

Build the request from flags, a JSON WhatsAppAgentBusinessInfoUpdate 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 agents business-info update --example

# the body it prints:

Code example

{
  "business_description": "A family-run shop selling garden tools and outdoor furniture across the Netherlands.",
  "return_policy": "Unused items can be returned within 30 days for a full refund; we email a return label on request."
}

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
`--business-description`	What the business does, in the words you want the agent to use. Omit to leave it as it is; null clears the field.
`--purchase-info`	How a contact buys from the business, such as where to order and which payment steps to expect. Omit to leave it as it is; null clears the field.
`--delivery-and-shipping`	How and when orders are delivered, and to where. Omit to leave it as it is; null clears the field.
`--return-policy`	How returns and refunds work. Omit to leave it as it is; null clears the field.
`--payment-method`	Which ways of paying the business accepts. Omit to leave it as it is; null clears the field.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird whatsapp agents business-info get`	Get what a WhatsApp agent knows about the business

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources