The organization, API key (name and last 4 characters, never the key) and project this server acts as. Call it first when you are unsure whether the key is an organization key or a project key.

List the linked WhatsApp numbers (accounts), newest first, with their status: ready can send; qr_ready waits for a QR scan; disconnected or failed need attention.

One account: status, linked phone number, profile name, proxy location, disconnect reason and last error. hasQrCode says a QR code is waiting to be scanned (get it with get_account_qr_code).

The QR code to scan in WhatsApp (Settings > Linked devices > Link a device), as an image. Waits a few seconds for one when the account is still starting. QR codes rotate about every 20 seconds: call again if it expired. Returns the status instead when the account is already linked, and the pairing code when it links by phone number.

Start linking a new WhatsApp number. Pick proxyLocation with list_proxy_locations (near where the phone is). Then show the QR code with get_account_qr_code, or pass pairingPhone to link with an 8-character pairing code instead. A linked number is billable; a new organization links its first number with no card. To let someone else link their own number, use create_invitation.

Link by phone number instead of QR code: returns an 8-character code the owner types in WhatsApp. It lives about 160 seconds. Fails with already_linked when the account is ready.

Restart the account's session. Use it when an account is disconnected; when the link is no longer valid it produces a fresh QR code.

Countries and cities a new number's proxy can exit from, for create_account and create_invitation. Search with q (sao finds Sao Paulo) or filter by country.

Send a text message from a linked number to a contact, group or channel. The message is queued and sent at the account's pace; the result has its id and queued status. Send only to people who expect it.

Send a file from a public URL: an image, video, audio, voice note (ogg/opus), document or sticker, with an optional caption. wuapi downloads the URL itself.

Send a map pin, with an optional place name and address.

Send one contact card, or up to 20 in one message.

Send a poll with 2 to 12 options. Votes arrive as poll.voted webhooks and in the message's poll tally (get_message).

Reply with text to a message, quoting it, in the same chat and from the same account. Works for messages in direct chats and groups.

React to a message with an emoji, as the account that received or sent it. An empty string removes the reaction.

One message with its status (queued, sent, delivered, read, failed, or received for inbound), content, and error when it failed.

Messages wuapi stored, newest first: sent and received. Filter by account, chat and direction to read a conversation. There is no endpoint that lists chats; recent messages show who wrote.

Change the text of an outbound text message, within WhatsApp's edit window (about 15 minutes). A message still queued is sent with the new text.

Delete an outbound message for everyone (or only on the linked devices with forEveryone: false). A message still queued is cancelled instead and never sent. This cannot be undone.

Stop a message that is still queued from being sent. It ends failed with error code cancelled. Fails with not_queued when the message already left; use delete_message for those.

Clear (or set, with unread: true) the chat's unread badge on the linked devices. Sends no read receipts; use send_read_receipts for blue ticks.

Send read receipts (blue ticks) for inbound messages in a chat: the given ids, or every unread inbound message wuapi stores for it.

Archive a chat on the linked devices, or unarchive it with archived: false.

Pin a chat to the top on the linked devices, or unpin it with pinned: false.

Mute a chat's notifications for a while or until unmuted, or unmute it with muted: false.

Which of these phone numbers have WhatsApp, with their contact id, business name and username when known. Check before sending to a new number.

About text, WhatsApp username, business name and device count of 1 to 50 contacts. Usernames cannot be searched: WhatsApp does not let a linked device resolve an @username, so look contacts up by number or lid: id.

Every group the account is in, read live from WhatsApp, with the participant count. Use get_group for the participants.

A group's name, description, settings and participants with their roles (member, admin, owner).

Create a WhatsApp group with the account as owner. Participants whose privacy settings refuse being added get an invite code instead (see the result).

Add participants to a group the account administers. Each result says whether it worked; someone who cannot be added directly comes back with an invite code.

Remove participants from a group the account administers.

Make participants admins of a group the account administers.

Turn group admins back into regular members.

The group's https://chat.whatsapp.com/... invite link. The account must be an admin.

Revoke the group's invite link and return a new one. Anyone holding the old link can no longer join with it.

Make the account leave a group. To come back it has to be added or invited again.

Post a story from the account: text on a colored background, or an image or video from a public URL with an optional caption.

The webhook endpoints that receive events: URL, events and whether active. Signing secrets are never shown here.

Register a public https URL to receive events as signed POST requests. The signing secret is not returned through this tool, to keep it out of the conversation: the user reveals it in the wuapi dashboard (Webhooks, rotate the endpoint's secret) and stores it with their server.

Change a webhook endpoint's URL or events, or pause it (active: false) and resume it.

Delete a webhook endpoint. Its events stop at once, including deliveries still retrying.

Projects: one per customer of a platform, each with its own numbers, keys, webhooks and usage. Organization keys only.

One project: name, external id, status, account limit and count. Organization keys only.

Create a project for one of your customers. Set externalId to your own customer id so you can address it as ext:<externalId>. Then invite the customer to link their number with create_invitation. Organization keys only.

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.

Invitations and their status: pending, in_progress, completed (with the new accountId), failed, cancelled or expired.

One invitation's status, and the linked accountId once completed.

Cancel an invitation: its link stops working. Completed invitations cannot be cancelled.

The current month's bill so far: billable numbers, proxy traffic, and the total in cents (USD). Organization keys only.

Numbers, proxy traffic and messages sent and received per project for a month, for rebilling your customers. With projectId, that project only. Organization keys only.