Overview
Manage your WhatsApp profile information including your display name, status message, and profile picture. You can also manage group profile pictures using the same methods.
Update Profile Name
Change your display name that appears to other users.
await sock.updateProfileName('My New Name')
Your profile name is visible to all WhatsApp users, subject to your privacy settings.
Update Profile Status
Set or update your status message (also known as “About”).
await sock.updateProfileStatus('Hey there! I am using WhatsApp.')
// Simple status
await sock.updateProfileStatus('Available')
// Status with emoji
await sock.updateProfileStatus('Working from home 🏠')
// Clear status
await sock.updateProfileStatus('')
Fetch User Status
Retrieve the status message of any WhatsApp user.
const jid = '[email protected]'
const status = await sock.fetchStatus(jid)
console.log('Status:', status)
Update Profile Picture
Change your profile picture or a group’s display picture.
For Your Own Profile
// Using file path
await sock.updateProfilePicture(
sock.user.id,
{ url: './my-photo.jpg' }
)
For a Group
const groupJid = '[email protected]'
await sock.updateProfilePicture(
groupJid,
{ url: './group-photo.jpg' }
)
You must be a group admin to change a group’s profile picture.
Supported Image Sources
You can provide images in multiple formats:
File URL
HTTP URL
Buffer
Stream
await sock.updateProfilePicture(
sock.user.id,
{ url: './profile-pic.jpg' }
)
await sock.updateProfilePicture(
sock.user.id,
{ url: 'https://example.com/photo.jpg' }
)
import { readFileSync } from 'fs'
const imageBuffer = readFileSync('./photo.jpg')
await sock.updateProfilePicture(
sock.user.id,
imageBuffer
)
import { createReadStream } from 'fs'
const imageStream = createReadStream('./photo.jpg')
await sock.updateProfilePicture(
sock.user.id,
{ stream: imageStream }
)
Custom Dimensions
You can specify custom dimensions for the profile picture:
await sock.updateProfilePicture(
sock.user.id,
{ url: './photo.jpg' },
{ width: 640, height: 640 }
)
Remove Profile Picture
Remove your profile picture or a group’s profile picture.
Remove Your Profile Picture
await sock.removeProfilePicture(sock.user.id)
Remove Group Profile Picture
Fetch Profile Picture
Retrieve the profile picture URL for any user or group.
Get Low Resolution Preview
const jid = '[email protected]'
const ppUrl = await sock.profilePictureUrl(jid)
console.log('Profile picture URL:', ppUrl)
Get High Resolution Image
const jid = '[email protected]'
const ppUrl = await sock.profilePictureUrl(jid, 'image')
console.log('High-res profile picture URL:', ppUrl)
For Groups
const groupJid = '[email protected]'
const groupPpUrl = await sock.profilePictureUrl(groupJid, 'image')
console.log('Group profile picture:', groupPpUrl)
Handle Missing Profile Pictures
const jid = '[email protected]'
try {
const ppUrl = await sock.profilePictureUrl(jid)
console.log('Profile picture:', ppUrl)
} catch (error) {
console.log('User has no profile picture')
}
Complete Profile Management Example
Here’s a complete example showing how to manage profile information:
import makeWASocket from '@whiskeysockets/baileys'
import { readFileSync } from 'fs'
const sock = makeWASocket({
// your config
})
sock.ev.on('connection.update', async (update) => {
if (update.connection === 'open') {
console.log('Connected! Updating profile...')
// Update profile name
await sock.updateProfileName('Bot Assistant')
console.log('Profile name updated')
// Update status message
await sock.updateProfileStatus('Powered by Baileys 🤖')
console.log('Status updated')
// Update profile picture
await sock.updateProfilePicture(
sock.user.id,
{ url: './bot-avatar.jpg' }
)
console.log('Profile picture updated')
// Fetch our own profile picture to verify
const myPpUrl = await sock.profilePictureUrl(sock.user.id, 'image')
console.log('My profile picture URL:', myPpUrl)
}
})
Download and Save Profile Pictures
Download profile pictures from other users:
import { writeFileSync } from 'fs'
import fetch from 'node-fetch'
async function downloadProfilePicture(jid: string, filename: string) {
try {
// Get high-res profile picture URL
const url = await sock.profilePictureUrl(jid, 'image')
if (url) {
// Download the image
const response = await fetch(url)
const buffer = await response.buffer()
// Save to file
writeFileSync(filename, buffer)
console.log(`Profile picture saved to ${filename}`)
}
} catch (error) {
console.log('Failed to download profile picture:', error.message)
}
}
// Usage
await downloadProfilePicture('[email protected]', 'user-profile.jpg')
Update Group Profile
Manage group profile information (requires admin privileges):
const groupJid = '[email protected]'
// Update group name
await sock.groupUpdateSubject(groupJid, 'New Group Name')
// Update group description
await sock.groupUpdateDescription(groupJid, 'This is our group description')
// Update group profile picture
await sock.updateProfilePicture(
groupJid,
{ url: './group-avatar.jpg' }
)
// Remove group profile picture
await sock.removeProfilePicture(groupJid)
Profile Update Events
Listen for profile picture changes of your contacts:
sock.ev.on('contacts.update', async (updates) => {
for (const contact of updates) {
if (typeof contact.imgUrl !== 'undefined') {
const newUrl = contact.imgUrl === null
? null
: await sock.profilePictureUrl(contact.id).catch(() => null)
console.log(`${contact.id} has a new profile picture:`, newUrl)
}
}
})
Error Handling
Always handle potential errors when updating profile information:
try {
await sock.updateProfileName('New Name')
console.log('Profile name updated successfully')
} catch (error) {
console.error('Failed to update profile name:', error.message)
}
try {
await sock.updateProfilePicture(
sock.user.id,
{ url: './invalid-image.jpg' }
)
} catch (error) {
console.error('Failed to update profile picture:', error.message)
}
Make sure images are in a supported format (JPEG, PNG) and have reasonable dimensions. Very large images may fail to upload.