Sign inGet Started

bird whatsapp agents allowlist create

Usage

Code example
bird whatsapp agents allowlist create <number-id> <phone-number> [flags]

Description

Add a contact to an agent's allowlist

Allow one more contact for the agent on this WhatsApp number to answer while its ai_audience is allowlist. Use it to try the agent on chosen people before widening the audience to everyone.

Build the request from the <phone_number> argument, a JSON WhatsAppAgentAllowlistEntryCreate body via --body-file ("-" reads stdin), or both — an inline value 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 allowlist create --example

# the body it prints:
Code example
{
  "phone_number": "+31612340001"
}

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
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents allowlist deleteRemove one of an agent's allowlist entries
bird whatsapp agents allowlist getGet one of an agent's allowlist entries
bird whatsapp agents allowlist listList an agent's allowlist entries

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