Profile Management

Manage your WhatsApp profile including name, status, and profile picture.

Get Profile

Get authenticated user's profile information.

GET /sessions/{id}/profile

Headers

Header	Value
X-API-Key	Your session API key

Example Request

curl -H "X-API-Key: wask_your_session_key" \
  http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile

Response

{
  "success": true,
  "profile": {
    "id": "919988066776@s.whatsapp.net",
    "name": "John Doe",
    "phone": "919988066776",
    "profilePicture": "https://pps.whatsapp.net/v/...",
    "status": "Hey there! I am using WhatsApp"
  }
}

Response Fields

Field	Type	Description
id	string	WhatsApp JID
name	string	Profile display name
phone	string	Phone number
profilePicture	string	Profile picture URL (null if not set)
status	string	Profile status/about (null if not set)

---

Update Profile Name

Update your WhatsApp profile display name.

PUT /sessions/{id}/profile/name

Headers

Header	Value
X-API-Key	Your session API key

Request Body

Parameter	Type	Required	Description
name	string	Yes	New profile name (max 25 characters)

Example Request

curl -X PUT http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile/name \
  -H "X-API-Key: wask_your_session_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith"
  }'

Response

{
  "success": true,
  "message": "Profile name updated successfully",
  "name": "John Smith"
}

info

WhatsApp limits profile name to 25 characters.

---

Update Profile Status

Update your WhatsApp profile status (About).

PUT /sessions/{id}/profile/status

Headers

Header	Value
X-API-Key	Your session API key

Request Body

Parameter	Type	Required	Description
status	string	Yes	New profile status/about text

Example Request

curl -X PUT http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile/status \
  -H "X-API-Key: wask_your_session_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "Available"
  }'

Response

{
  "success": true,
  "message": "Profile status updated successfully",
  "status": "Available"
}

---

Update Profile Picture

Update your WhatsApp profile picture.

PUT /sessions/{id}/profile/picture

Headers

Header	Value
X-API-Key	Your session API key

Request Body

Parameter	Type	Required	Description
image	string	Yes	Image URL or base64 encoded image

Example Request (URL)

curl -X PUT http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile/picture \
  -H "X-API-Key: wask_your_session_key" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "https://example.com/profile.jpg"
  }'

Example Request (Base64)

curl -X PUT http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile/picture \
  -H "X-API-Key: wask_your_session_key" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD..."
  }'

Response

{
  "success": true,
  "message": "Profile picture updated successfully"
}

Image Requirements

• Supported formats: JPEG, PNG
• Recommended size: 640x640 pixels
• Max file size: 5MB
• Image will be automatically cropped to square

---

Delete Profile Picture

Remove your WhatsApp profile picture.

DELETE /sessions/{id}/profile/picture

Headers

Header	Value
X-API-Key	Your session API key

Example Request

curl -X DELETE http://localhost:3000/sessions/e67a00be-ed45-4356-9488-049cabb9895d/profile/picture \
  -H "X-API-Key: wask_your_session_key"

Response

{
  "success": true,
  "message": "Profile picture deleted successfully"
}

---

Error Responses

Not Authenticated

{
  "success": false,
  "error": "Not authenticated"
}

Solution: Ensure your session is in ready state. Check session status first.

Invalid Image Format

{
  "success": false,
  "error": "Invalid image format"
}

Solution: Use JPEG or PNG format. Ensure base64 string is properly formatted.

Name Too Long

{
  "success": false,
  "error": "Name must be 25 characters or less"
}

Solution: Shorten the profile name to 25 characters or less.