Skip to main content

Profile

client.profile (WaProfileCoordinator) reads and writes profile fields for your account and looks them up for others.

Profile picture

getProfilePicture(jid, type?, existingId?) returns a WaProfilePictureResult{ url?, directPath?, id?, type? }. The second argument picks between the compact 'preview' variant (default) and the high-resolution 'image' original; both flavors are returned as the same envelope, only the bytes behind url / directPath differ. Pass the cached existingId to let the server short-circuit when the picture hasn’t changed (the result then comes back without the new url/directPath).

About / status text

Push name

pushName is the display name peers see for your account in chats and group participant lists. The change is applied to the local credentials immediately (so client.getCredentials()?.pushName reflects the new value right away) and is routed through an app-state mutation; peers see the new name on your next outgoing message.
Passing an empty string resets the name to the device fingerprint default.

Default disappearing mode

setDisappearingMode sets the account-wide default lifetime applied to new 1:1 chats you start. Existing chats keep their per-chat setting.
For per-group disappearing messages, see Groups → disappearing messages.

Batched lookups

Check if a number is on WhatsApp

Resolve phone numbers to their LID and learn whether each is registered on WhatsApp:

Usernames

Privacy

client.privacy (WaPrivacyCoordinator) controls privacy categories and the blocklist.

Privacy settings

Setting names and values come from the WA_PRIVACY_* constants (last, online, profile, status, readreceipts, groupadd, …). See the JID & constants reference.

Blocklist

Disallowed lists

For settings scoped to a specific list of contacts (e.g. “share with everyone except…”):

Business

client.business (WaBusinessCoordinator) reads business profiles and verified names, and manages your own business profile. Business account — required to edit your own profile or cover photo; the read methods work for any account.

Typed business hours

WaBusinessHoursDay and WaBusinessHoursMode are union aliases ('sun' | 'mon' | …, 'open_24h' | 'specific_hours' | 'appointment_only'). The values are also frozen on WA_BUSINESS_HOURS_DAYS and WA_BUSINESS_HOURS_MODES. Passing an unknown mode to editBusinessProfile now throws a clear local error instead of the server replying with 406 not-acceptable — closed days are still expressed by omitting them from config, not by a dedicated mode.

Chat settings

Per-chat settings — mute, pin, archive, read, lock, star, clear, delete — live on client.chat and sync across your devices. They have their own guide:

Managing chats

Mute, pin, archive, mark read, lock, star messages, clear, and delete chats.
Last modified on June 12, 2026