Invite someone to link their number
create_invitationGenerate a branded page URL so customers can link their WhatsApp number to your project by QR code or pairing code, without needing an account. Share the returned URL or provide inviteeEmail for wuapi to send it.
Instructions
Create a branded page (url) where a customer links their own WhatsApp number to your project by QR code or pairing code, without an account on wuapi. Send them the url: it is returned only here. With inviteeEmail, wuapi can email it too.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| methods | No | How they may link. Default both. | |
| projectId | No | Organization keys only: the project to create it in (id or `ext:<externalId>`). A project key always uses its own project. | |
| returnUrl | No | Where the page sends them when done. | |
| accountName | No | Name of the account created when they finish. | |
| historySync | No | ||
| inviteeName | No | ||
| inviteeEmail | No | ||
| inviteePhone | No | E.164. | |
| expiresInDays | No | 1 to 30. Default 7. | |
| proxyLocation | No | Preset the proxy location. Without it the invitee picks the country and city. | |
| idempotencyKey | No | Optional. Reuse the same key when retrying this exact call: within 24 hours wuapi returns the first result instead of doing it twice. | |
| suggestedCountry | No | ISO country preselected on the page. |