Sign inGet Started

bird whatsapp agents websites update

Usage

Code example
bird whatsapp agents websites update <number-id> <website-id> [flags]

Description

Change the address of one of an agent's websites

Point one website entry on the agent on this WhatsApp number at a new address. WhatsApp reads the new page in place of the old one, so check the entry's crawl_status with bird whatsapp agents websites get before expecting answers from it.

Build the request from flags, a JSON WhatsAppAgentWebsiteUpdate 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 websites update --example

# the body it prints:
Code example
{
  "url": "https://example.com/help/returns"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--urlThe new address for WhatsApp to read. WhatsApp starts reading it as soon as it accepts the change, and the entry's crawl_status goes back to pending until it has finished. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents websites createAdd a website to an agent
bird whatsapp agents websites deleteRemove one of an agent's websites
bird whatsapp agents websites getGet one of an agent's websites
bird whatsapp agents websites listList an agent's websites

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