Send WhatsApp address-request message
Prompt the recipient to submit (or pick a saved) structured delivery address, inside the 24h customer-service window — no template review required. country (ISO 3166-1 alpha-2) selects the field set Meta renders. The reply arrives as an address_message interactive reply on the inbound webhook.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Body
Recipient E.164 phone number OR WhatsApp Business Solution UID.
1Prompt text shown above the address form (1-1024 chars).
1 - 1024ISO 3166-1 alpha-2 country code selecting Meta's address field set (e.g. IN, SG).
2Optional pre-fill values keyed by Meta's per-country field names.
Optional previously-saved addresses the recipient can pick from, in markets that support it.
Response
Successful response.