Skip to main content
These endpoints operate on the connected WhatsApp account and its contacts.

User lookup

EndpointBodyUse
POST /user/checkPhone: []stringCheck whether phone numbers are on WhatsApp.
POST /user/infoPhone: []stringFetch WhatsApp user info for one or more users.
POST /user/avatarPhone, PreviewFetch profile picture information for a user.
GET /user/avatarnoneRoute exists, but the handler reads JSON body. Prefer POST for target avatars.
POST /user/parselidlidConvert an LID value to a parsed JID.
Example:
{
  "Phone": ["15551234567", "15557654321"]
}

Account state

EndpointUse
GET /user/privacyGet privacy settings for the connected account.
GET /user/contactsList locally stored contacts for the account.
GET /user/blocklistList blocked contacts.
GET /user/limitsGet messaging cap and reachout timelock information.
GET /user/appstateRefetch app state for the connected account.

Profile updates

EndpointBodyUse
POST /user/profileImageSet the account profile picture from a base64 image data URL.
POST /user/nameNameUpdate the account push name.
POST /user/presencePresenceSet account presence. Valid values are available or unavailable.

Block and unblock

curl -X POST http://localhost:1337/user/block \
  -H "Content-Type: application/json" \
  -H "token: YOUR_TOKEN" \
  -d '{"Phone":"15551234567"}'
Use /user/unblock with the same body to unblock.

Contacts

EndpointBodyUse
POST /contact/addPhone, FirstName, FullName, SaveOnBookSave a WhatsApp contact action for the account.
POST /contact/removePhoneRemove a contact action for the account.
These actions affect WhatsApp contact state, not necessarily the phone’s native address book.

Broadcasts

POST /broadcast/listparticipants accepts:
{
  "id": "broadcast-id"
}
It returns the participants known for that broadcast.