> ## Documentation Index > Fetch the complete documentation index at: https://zapo.to/llms.txt > Use this file to discover all available pages before exploring further. # WaClient & coordinators > Complete method reference for WaClient and every coordinator: auth, message, presence, chat, group, newsletter, profile, and more. This page lists **every** public method on `WaClient` and its coordinators, with code-grounded descriptions. Dedicated pages go deeper for [message types](/en/reference/message-types), [chat mutations](/en/reference/chat-mutations), and the [low-level API](/en/reference/low-level). ## WaClient ```ts theme={null} new WaClient(options: WaClientOptions, logger?: Logger) ``` See [Configuration](/en/concepts/configuration) for every option. | Member | Signature | Description | | --------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `connect` | `() => Promise` | Opens the socket and runs the Noise handshake; drives pairing on first run. Resolves once connected. | | `disconnect` | `() => Promise` | Flushes pending write-behind and closes the socket, keeping credentials. | | `logout` | `(reason?: WaLogoutReason) => Promise` | Unlinks this companion device server-side; then clears stored state per [`logoutStoreClear`](/en/concepts/configuration#logout-store-clearing). Throws if not authenticated. | | `getState` | `() => WaAuthState` | Current auth/connection state. | | `getCredentials` | `() => WaAuthCredentials \| null` | Current credentials, if paired. | | `getClockSkewMs` | `() => number \| null` | Estimated server clock skew (from keep-alive), or `null`. | | `ignoreKey` | `(input: WaIgnoreKey \| WaIgnoreKeyPredicate) => () => void` | Drop matching inbound stanzas **before** any handler runs — descriptor or predicate (see [Ignoring inbound stanzas](#ignoring-inbound-stanzas)). Returns an `unregister` function. | | `on` / `once` / `off` | `(event, listener) => this` | Typed event emitter over [`WaClientEventMap`](/en/concepts/events). | ### Ignoring inbound stanzas `client.ignoreKey(input)` drops matching ``, ``, ``, ``, ``, and `` stanzas before any handler — including the persistence and decryption paths — sees them. The coordinator still sends the appropriate ack so the server stops re-delivering. It accepts two shapes: #### Declarative descriptor — `WaIgnoreKey` ```ts theme={null} import type { WaIgnoreKey } from 'zapo-js' // Drop everything from one peer const off = client.ignoreKey({ remoteJid: spammerJid }) // Drop only that peer's messages (keep receipts / presence) client.ignoreKey({ remoteJid: spammerJid, only: ['message'] }) // Drop your own outbound message echoes (multi-device fan-in) client.ignoreKey({ fromMe: true, only: ['message'] }) off() // unregister ``` | Field | Type | Notes | | ------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `remoteJid` | `string \| readonly string[]` | The chat JID. Array entries OR. Also matches the alt `sender_pn` / `sender_lid` / `participant_pn` / `participant_lid` attrs (and `sender_lid` on ``), so one JID form catches the other. | | `fromMe` | `boolean` | Whether the stanza was sent by this account. | | `id` | `string` | Stanza id. | | `participant` | `string` | The author in groups / broadcasts. Also matches the alt forms. | | `only` | `readonly ('message' \| 'receipt' \| 'notification' \| 'presence' \| 'chatstate' \| 'call')[]` | Restrict to specific tags. Default: all six. | Multiple top-level fields **AND** together; the `remoteJid` array **ORs**. At least one of `remoteJid` / `fromMe` / `id` / `participant` is required — empty descriptors and empty arrays throw. #### Predicate — `WaIgnoreKeyPredicate` For anything the descriptor can't express (chat-kind filters, custom rules combining several fields), pass a predicate `(ctx: WaIgnoreKeyContext) => boolean`. Return `true` to drop. The lib has already parsed the wire-format node before calling you — no `BinaryNode` digging required. ```ts theme={null} import { isGroupJid, isStatusBroadcastJid, isNewsletterJid } from 'zapo-js' // Drop every group message; keep group receipts/notifications client.ignoreKey((m) => m.kind === 'message' && isGroupJid(m.remoteJid ?? '')) // Drop status broadcasts entirely client.ignoreKey((m) => isStatusBroadcastJid(m.remoteJid ?? '')) // 1:1 only — drop anything from a group, broadcast, or newsletter client.ignoreKey((m) => { const j = m.remoteJid ?? '' return isGroupJid(j) || isStatusBroadcastJid(j) || isNewsletterJid(j) }) ``` `WaIgnoreKeyContext` carries the same fields the descriptor matches on, already parsed: | Field | Type | Notes | | ------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kind` | `'message' \| 'receipt' \| 'notification' \| 'presence' \| 'chatstate' \| 'call'` | Stanza tag. | | `remoteJid` | `string \| null` | Deviceless chat JID — group JID for groups, PN or LID **user**-form JID for 1:1 (the `:device` segment is stripped to match `event.key.remoteJid`). Userless `from` values (e.g. `s.whatsapp.net`) are kept verbatim. | | `fromMe` | `boolean` | Already resolved against the account's `meJid`. | | `id` | `string \| undefined` | Stanza id. | | `participant` | `string \| null` | The author in groups / broadcasts. Same device-stripping as `remoteJid`; `null` for non-group stanzas. | The predicate sees the device-stripped `from` / `participant` — but **no** PN ↔ LID alt-attr resolution. The descriptor form is what handles the PN ↔ LID part automatically; if you need both per-JID matching with alt-form coverage *and* a custom rule, prefer the descriptor's `remoteJid` with `only`. Stream-control nodes and the connection-critical `success` / `failure` tags bypass filters so the auth flow stays intact. ### Coordinator getters | Getter | Type | Section | | --------------- | ------------------------------- | ---------------------------------------- | | `auth` | `WaAuthClient` | [auth](#auth) | | `message` | `WaMessageCoordinator` | [message](#message) | | `presence` | `WaPresenceCoordinator` | [presence](#presence) | | `chat` | `WaAppStateMutationCoordinator` | [chat](#chat) | | `group` | `WaGroupCoordinator` | [group](#group) | | `status` | `WaStatusCoordinator` | [status](#status) | | `broadcastList` | `WaBroadcastListCoordinator` | [broadcastList](#broadcastlist) | | `newsletter` | `WaNewsletterCoordinator` | [newsletter](#newsletter) | | `privacy` | `WaPrivacyCoordinator` | [privacy](#privacy) | | `profile` | `WaProfileCoordinator` | [profile](#profile) | | `business` | `WaBusinessCoordinator` | [business](#business) | | `bot` | `WaBotCoordinator` | [bot](#bot) | | `email` | `WaEmailCoordinator` | [email](#email) | | `mobile` | `WaMobileCoordinator` | [mobile](#mobile) | | `lowlevel` | `WaLowLevelCoordinator` | [low-level API](/en/reference/low-level) | *** ## auth `client.auth` (`WaAuthClient`). Pairing is mostly event-driven ([Authentication](/en/concepts/authentication)); these are the user-facing entry points. | Method | Signature | Description | | ---------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `requestPairingCode` | `(phoneNumber, shouldShowPushNotification?, customCode?) => Promise` | Requests an 8-char pairing code (link-code flow). The client must already be connected — call after the `auth_pairing_required` event. `customCode` suggests a code; the server may return a different one. | | `fetchPairingCountryCodeIso` | `() => Promise` | The ISO country code the server resolved for the account. | | `getState` | `(connected?) => { connected, registered, hasQr, hasPairingCode }` | Auth readiness flags. | | `getCurrentCredentials` | `() => WaAuthCredentials \| null` | Loaded credentials, or `null`. | *** ## message `WaMessageCoordinator` — see [Sending](/en/guides/sending-messages) & [Receiving](/en/guides/receiving-messages). | Method | Signature | Description | | -------------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `send` | `(to, content: WaSendMessageContent, options?: WaSendMessageOptions) => Promise` | Sends any [content type](/en/reference/message-types); handles device fanout and per-send retries. Returns the stanza id + ack metadata. | | `sendReceipt` | `(event\|events, options?)` / `(jid, ids, options?) => Promise` | Sends a delivery/read/played/inactive receipt. Delivery is auto-acked on decrypt; use this for manual read/played. | | `requestHistorySync` | `(input: WaRequestHistorySyncInput) => Promise<{ messageId }>` | Asks the server to backfill older messages for a chat. Resolves once dispatched — the backlog arrives later as `history_sync_chunk`. See [Requesting older history](/en/guides/receiving-messages#requesting-older-history). | | `download` | `(source, options?) => Promise` | Streams decrypted media (MAC + SHA-256 verified as consumed). Cancel via `options.signal`. | | `downloadToFile` | `(source, filePath, options?) => Promise` | Streams decrypted media to a file. | | `downloadBytes` | `(source, options?) => Promise` | Buffers decrypted media into memory — small media only; cap with `options.maxBytes`. | | `tryDecryptAddon` | `(event) => Promise` | Decrypts an addon (poll vote, reaction, …) and emits `message_addon`. Auto-called by default; opt out with `addons: { autoDecrypt: false }` to call it yourself. | | `syncSignalSession` | `(jid, reasonIdentity?) => Promise` | Force-refreshes the Signal session(s) for a JID; `reasonIdentity` also reissues the trusted-contact token. | | `getReachoutTimelock` | `() => Promise` | Server-side timelock that throttles cold outreach to non-contacts. | | `getNewChatMessageCapping` | `(type?) => Promise` | Per-cycle message quota applied to new-chat threads (quota, used, cycle, status). | `source` is a `WaIncomingMessageEvent` or a raw `Proto.IMessage`. *** ## presence `WaPresenceCoordinator` — see [Presence & status](/en/guides/presence-status). | Method | Signature | Description | | --------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `send` | `(type?: 'available' \| 'unavailable') => Promise` | Broadcasts your online/offline presence. | | `sendChatstate` | `(jid, options) => Promise` | Sends a typing/recording/paused hint into a chat. | | `subscribe` | `(jid, options?) => Promise` | Subscribes to a contact's presence/chat-state. Per-jid and per-connection — **re-subscribe after reconnect**. | *** ## chat `WaAppStateMutationCoordinator` — full reference (incl. the generic `set`/`remove` and all schemas) in [Chat mutations](/en/reference/chat-mutations). | Method | Signature | | --------------------------------------------------------------- | -------------------------------------------------------- | | `setChatMute` | `(chatJid, muted, muteEndTimestampMs?) => Promise` | | `setChatPin` / `setChatArchive` / `setChatRead` / `setChatLock` | `(chatJid, boolean) => Promise` | | `setMessageStar` | `(message, starred) => Promise` | | `clearChat` / `deleteChat` | `(chatJid, options?) => Promise` | | `deleteMessageForMe` | `(message, options?) => Promise` | | `setStatusPrivacy` / `setUserStatusMute` | `(input) / (jid, muted) => Promise` | | `setBroadcastList` / `removeBroadcastList` | `(input) / (id) => Promise` | | `set` / `remove` | `(input) => Promise` | | `sync` / `flushMutations` | `(options?) / () => Promise<…>` | | `getBlockedCollections` / `emitEventsFromSyncResult` | `(syncResult) => …` | Pin and archive are mutually exclusive (pinning clears archive and vice-versa); locking clears both. `clearChat`/`deleteChat`/`deleteMessageForMe` are **local-only** (your devices) — use a [revoke](/en/guides/interactive-messages#revoking-delete-for-everyone) to delete for everyone. A mute timer doesn't auto-unmute client-side. *** ## group `WaGroupCoordinator` — see [Groups & communities](/en/guides/groups). Participant ops return one [`WaParticipantActionResult`](/en/guides/groups#managing-participants) per jid — the IQ succeeds as a whole even when some entries fail, so check each result's `status` / `code`. | Method | Signature | Description | | -------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `queryGroupMetadata` | `(groupJid) => Promise` | Full group metadata. | | `queryAllGroups` | `() => Promise` | Every group the account is in. | | `queryGroupInviteInfo` | `(code) => Promise` | Preview an invite code (subject, size, ephemeral, description, trimmed participant sample). | | `createGroup` | `(subject, participants, options?) => Promise` | Create a group (you're auto-added as admin; don't include your own JID). Returns the new group's metadata. | | `setSubject` | `(groupJid, subject) => Promise` | Rename. | | `setDescription` | `(groupJid, description\|null, prevDescId?) => Promise` | Set/clear description. | | `setSetting` | `(groupJid, setting, enabled) => Promise` | Toggle a boolean group flag (`announcement`, `restrict`, `ephemeral`, `group_history`, `allow_admin_reports`, `no_frequently_forwarded`, community flags). | | `setMemberAddMode` | `(groupJid, 'admin_add' \| 'all_member_add') => Promise` | Restrict member adds to admins (or open to all). Admin op. | | `setMemberLinkMode` | `(groupJid, 'admin_link' \| 'all_member_link') => Promise` | Restrict invite-link sharing to admins (or open to all). Admin op. | | `setMemberShareGroupHistoryMode` | `(groupJid, 'admin_share' \| 'all_member_share') => Promise` | Hide or expose prior chat history to newly added members. Admin op. | | `setEphemeralDuration` | `(groupJid, expirationSeconds, trigger?) => Promise` | Turn on disappearing messages with a specific lifetime (`86400` = 24h, `604800` = 7d, `7776000` = 90d). Use `setSetting('ephemeral', false)` to disable. Admin op. | | `addParticipants` / `removeParticipants` | `(groupJid, jids) => Promise` | Add / remove members. One result per jid; inspect `status` / `code` for partial failures. | | `promoteParticipants` / `demoteParticipants` | `(groupJid, jids) => Promise` | Grant / revoke admin. Same per-jid result shape. | | `leaveGroup` | `(groupJids) => Promise` | Leave one or more groups (batched). | | `queryInviteCode` | `(groupJid) => Promise` | Fetch the current invite code (the path segment of `chat.whatsapp.com/`) **without** rotating it. Admin op — non-admins get `403 not-authorized`. | | `revokeInvite` | `(groupJid) => Promise` | Rotate the invite code — every old `chat.whatsapp.com/` link stops working. Returns the new `code` plus any `affectedParticipants`. | | `joinGroupViaInvite` | `(code) => Promise` | Join via code. Throws if expired/revoked/full/already a member. Returns the joined group's metadata. | | `createCommunity` | `(subject, options?) => Promise` | Create a community (request-required unless `membershipApprovalMode: 'open'`). | | `deactivateCommunity` | `(communityJid) => Promise` | Delete a community. | | `linkSubGroups` / `unlinkSubGroups` | `(communityJid, jids, options?) => Promise<…>` | Link / unlink sub-groups (`removeOrphanedMembers` evicts orphaned members). | | `queryLinkedGroupsParticipants` | `(communityJid) => Promise` | Merged participants across a community. | | `fetchSubGroups` | `(communityJid) => Promise` | List sub-groups (MEX). | | `joinLinkedGroup` | `(communityJid, subGroupJid, options?) => Promise` | Join a linked sub-group. Call `queryGroupMetadata` afterward for the full metadata. | | `queryMembershipApprovalRequests` | `(groupJid) => Promise` | Pending join requests. | | `approveMembershipRequests` / `rejectMembershipRequests` | `(groupJid, jids) => Promise` | Approve / reject requests. | | `cancelMembershipRequests` | `(groupJid, jids) => Promise` | Cancel your own pending requests. | | `isInternalGroup` | `(groupJid) => Promise` | `true` for internal WhatsApp groups (MEX). | | `transferCommunityOwnership` | `(communityJid, newOwnerJid) => Promise` | Hand off community ownership (MEX). | | `fetchSubgroupSuggestions` | `(communityJid, hintSubgroupJid) => Promise` | Suggested sub-groups (MEX). | | `submitGroupSuspensionAppeal` | `(groupJid, options?) => Promise` | Appeal a suspension (MEX). | Methods marked (MEX) require an active [MEX](/en/reference/glossary#mex) transport and throw when it's unavailable. *** ## newsletter `WaNewsletterCoordinator` — see [Newsletters](/en/guides/newsletters). Composed of discovery, admin, and messaging ops. ### Discovery | Method | Signature | Description | | --------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------ | | `fetch` / `fetchByInvite` | `(jid\|code, options?) => Promise` | Metadata by JID or invite code. | | `fetchDehydrated` | `(keyOrInvite, options?) => Promise` | Lightweight metadata (no image/followers). | | `listSubscribed` | `(options?) => Promise` | Channels you follow. | | `searchDirectory` | `(options?) => Promise` | Search the public directory. | | `fetchRecommended` | `(options?) => Promise` | Recommended channels. | | `fetchSimilar` | `(jid, options?) => Promise` | Channels similar to one. | | `fetchDirectoryList` | `(options) => Promise` | Paged directory by country/category. | | `fetchDirectoryCategoriesPreview` | `(options) => Promise` | Category carousel previews. | | `fetchIsDomainPreviewable` | `(domains) => Promise>` | Which domains support link previews. | ### Admin | Method | Signature | Description | | ----------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `create` | `(input) => Promise` | Create a channel (auto-accepts creation TOS; `picture` uploaded inline — keep small). | | `update` | `(jid, input) => Promise` | Edit name/description/picture. | | `delete` | `(jid) => Promise` | **Irreversible** delete — followers detached, history dropped, JID burned. | | `fetchAdminInfo` | `(jid) => Promise` | Admin-only metadata view. | | `fetchAdminCapabilities` | `(jid) => Promise>` | Capabilities granted to the account. | | `fetchFollowers` | `(jid, options?) => Promise` | Paged follower list. | | `fetchInsights` | `(jid, metrics) => Promise<… \| null>` | Admin analytics. | | `fetchReports` | `() => Promise<… \| null>` | Moderation reports against owned channels. | | `fetchPendingInvites` | `(jid) => Promise` | Pending admin invite JIDs. | | `fetchEnforcements` | `(jid) => Promise<… \| null>` | Moderation enforcement state. | | `fetchPollVoters` | `(input) => Promise>` | Poll voters grouped by option. | | `fetchMessageReactionSenders` | `(input) => Promise` | Reaction senders grouped by emoji. | | `createAdminInvite` | `(input) => Promise` | Invite a user as admin. | | `acceptAdminInvite` | `(jid) => Promise` | Accept a pending admin invite (auto-accepts TOS). | | `revokeAdminInvite` | `(input) => Promise` | Revoke a sent admin invite. | | `changeOwner` | `(input) => Promise` | Transfer ownership to an invited admin. | | `demoteAdmin` | `(input) => Promise` | Demote an admin to follower. | | `queryTosState` / `acceptTos` | `(noticeIds) => Promise<…>` | Query / accept TOS notices. | | `logExposures` | `(exposures) => Promise` | Report capability exposures (telemetry). | ### Messaging | Method | Signature | Description | | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------- | | `send` | `(jid, content, options?) => Promise` | Publish a message (any content type). | | `editMessage` | `(jid, parentMessageId, content) => Promise` | Edit a published message. | | `react` / `revoke` / `votePoll` / `sendViewReceipt` | `(input) => Promise<{ stanzaId }>` | React / revoke / vote / view-receipt. | | `fetchMessages` / `fetchMessageUpdates` | `(input) => Promise` | Page messages / fetch edits-reactions-votes in a range. | | `subscribeLiveUpdates` | `(jid) => Promise<{ durationSeconds }>` | Subscribe to live updates (**re-subscribe after reconnect**). | | `follow` / `unfollow` | `(jid) => Promise` | Follow / unfollow. | | `mute` | `(input) => Promise` | Mute / unmute. | *** ## privacy `WaPrivacyCoordinator` — see [Privacy](/en/guides/profile-privacy#privacy). | Method | Signature | Description | | --------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `getPrivacySettings` | `() => Promise` | Current value of every privacy category. | | `setPrivacySetting` | `(setting, value) => Promise` | Update one category. A `contact_blacklist`-style value flips the mode only — populate the list separately via the disallowed-list + app-state. | | `getDisallowedList` | `(category) => Promise` | Per-category excluded JIDs. | | `getBlocklist` | `() => Promise` | Account-wide blocklist. | | `blockUser` / `unblockUser` | `(jid) => Promise` | Block / unblock. A block stops the peer messaging/calling you and hides your last-seen/online/photo/status from them. | *** ## profile `WaProfileCoordinator` — see [Profile](/en/guides/profile-privacy#profile). | Method | Signature | Description | | --------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `getProfilePicture` | `(jid, type?: 'preview' \| 'image', existingId?) => Promise` | Picture envelope (`{ url?, directPath?, id?, type? }`). `type` defaults to `'preview'` (compact variant); `'image'` returns the high-resolution original. Pass the cached `existingId` to let the server short-circuit when the picture hasn't changed. | | `setProfilePicture` | `(imageBytes, targetJid?) => Promise` | Set your/a target's picture. `imageBytes` is uploaded **as-is** — pre-encode square JPEG. Returns the picture id. | | `deleteProfilePicture` | `(targetJid?) => Promise` | Remove the picture (admin op for groups). | | `getStatus` / `setStatus` | `(jid) / (text) => Promise<…>` | Get/set the legacy "About". | | `setPushName` | `(name) => Promise` | Update the display name broadcast to peers. Applied to the local credentials immediately and routed through an app-state mutation; peers see it on your next outgoing message. Empty string resets to the device default. | | `getProfiles` | `(jids) => Promise` | Batched picture id + status. | | `getDisappearingMode` | `(jids) => Promise` | Batched disappearing-mode setting. | | `setDisappearingMode` | `(durationSeconds) => Promise` | Set the account-wide default disappearing-mode duration for **new** 1:1 chats (`0`/`86400`/`604800`/`7776000`). Existing chats keep their setting. | | `getTextStatuses` | `(jids) => Promise` | Batched modern text status (emoji + text). | | `setTextStatus` | `(input) => Promise` | Set your modern text status; `text: null`/`''` clears it. | | `getUsernames` | `(jids) => Promise` | Batched username lookup. | | `getOwnUsername` | `() => Promise` | Your username record (value, state, recovery pin). | | `setUsername` | `(input) => Promise` | Reserve a username. Returns `true` only on `SUCCESS`; otherwise `false` (taken/invalid/rate-limited) without throwing. | | `deleteUsername` | `() => Promise` | Delete your username. | | `checkUsernameAvailability` | `(username) => Promise` | Availability + suggestions. | | `setUsernameKey` | `(pin) => Promise` | Set the username recovery PIN. | | `getAboutStatus` | `(jid) => Promise` | "About" text via MEX. | | `getLidsByPhoneNumbers` | `(phoneNumbers) => Promise` | Resolve [LIDs](/en/concepts/identities#mapping-a-phone-number-to-its-lid) for phone numbers. | *** ## status `WaStatusCoordinator` — see [Status broadcasts](/en/guides/presence-status#status-broadcasts). | Method | Signature | Description | | -------------- | --------------------------------------------------------------- | ------------------------------- | | `send` | `(input: WaSendStatusInput) => Promise` | Publish a status to recipients. | | `revokeStatus` | `(input) => Promise` | Revoke a published status. | | `setPrivacy` | `(input) => Promise` | Account-wide status privacy. | | `setUserMuted` | `(jid, muted) => Promise` | Mute/unmute a contact's status. | *** ## broadcastList `WaBroadcastListCoordinator`. | Method | Signature | Description | | ------------ | ----------------------------------------------------------------------------- | ----------------------------------------- | | `setList` | `(input: WaSetBroadcastListInput) => Promise` | Create/update a list (name + recipients). | | `removeList` | `(id) => Promise` | Delete a list. | | `send` | `(input: WaSendBroadcastListMessageInput) => Promise` | Send to every member. | Broadcast lists are **business-only** (backed by the `BusinessBroadcastList` app-state schema); regular accounts have the mutations rejected. *** ## business `WaBusinessCoordinator` — see [Business](/en/guides/profile-privacy#business). | Method | Signature | Description | | -------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------- | | `getBusinessProfile` | `(jids) => Promise` | Batched business profiles (about, address, hours). Works from any account. | | `getVerifiedName` / `getVerifiedNames` | `(jid) / (jids) => Promise<…>` | Verified-name lookup (single / batched). | | `editBusinessProfile` | `(input) => Promise` | Edit your business profile. **Business-only.** | | `updateCoverPhoto` | `(media) => Promise<{ id }>` | Upload/bind a cover photo. **Business-only.** | | `deleteCoverPhoto` | `(id) => Promise` | Delete the cover photo. **Business-only.** | *** ## bot `WaBotCoordinator` — see [Bots](/en/guides/bots). | Method | Signature | Description | | ----------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `listBots` | `() => Promise` | Bots available to the account, grouped by section. | | `getBotProfile` | `(jid, options?) => Promise` | A bot's profile (commands, prompts, creator). | | `sendPrompt` | `(to, content, options?) => Promise` | Prompt a bot — direct path (`to` is `@bot`) or mention path (group + `options.botJid`). | | `tryDecryptChunk` | `(event) => Promise` | Decrypt a streamed reply chunk → `message_bot_chunk`. Auto-called per incoming message. | *** ## email `WaEmailCoordinator`. | Method | Signature | Description | | ------------------------- | --------------------------------------------- | ----------------------------------------------- | | `getStatus` | `() => Promise` | Current binding (address + verified/confirmed). | | `setEmail` | `(email, context?) => Promise` | Bind/rebind an address. | | `requestVerificationCode` | `(input) => Promise` | Send a verification code to the address. | | `verifyCode` | `(code) => Promise` | Submit the emailed code. | | `confirm` | `(context?) => Promise` | Post-verification ownership confirmation. | Email binding is **mobile-only** — every method throws on a Web/companion connection. See [Mobile connections](/en/concepts/mobile). *** ## mobile `WaMobileCoordinator` — see [Hosting companion devices](/en/concepts/mobile#hosting-companion-devices). Requires a mobile-primary session; link/revoke/publish methods throw on a Web/companion connection. | Method | Signature | Description | | --------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `linkCompanion` | `(qr) => Promise` | Link a companion by its QR string. Returns `{ deviceJid, keyIndex }`. | | `linkCompanionByCode` | `(pairingCode) => Promise` | Link a companion by its 8-char pairing code (the companion must have requested a code for this account first). | | `revokeCompanion` | `(deviceJid, reason?) => Promise` | Unlink a hosted companion and republish the key-index list. `reason` defaults to `'user_initiated'`. | | `revokeAllCompanions` | `(reason?, { excludeHostedCompanion? }?) => Promise` | "Log out all companion devices"; opt-in `excludeHostedCompanion` spares the companions this account itself hosts. | | `listCompanions` | `() => Promise` | The companions this primary has linked in the current epoch. | | `reconcileCompanions` | `() => Promise` | Reconcile the tracked set against the server (`usync`); runs automatically on connect and on `account_sync`. Returns the removed device jids. | | `publishKeyIndexList` | `() => Promise` | Re-sign and republish the key-index list for the current device set. | *** ## lowlevel `WaLowLevelCoordinator` — full reference in [Low-level API](/en/reference/low-level): `sendNode`, `query`, `registerIncomingHandler`, `unregisterIncomingHandler`, `registerIncomingStanzaFilter`. *** For top-level helpers exported from the package root — message inspection (`getContentType`), target normalization (`resolveMessageTarget`), JID predicates and constants — see [JIDs, helpers & constants](/en/reference/jid-helpers). For typed business hours, see [Profile, privacy & business](/en/guides/profile-privacy#typed-business-hours).