Skip to main content
PUT
/
api
/
{session}
/
profile
/
picture
{
    "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

{
    "success": true
}

​
Description

This endpoint allows you to update the profile picture of the user authenticated in the WhatsApp session. The image must be sent in base64 format.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID

​
Request Body

​
picture
string
required
Profile picture image encoded in base64. The image will be set as the new user profile picture on WhatsApp.
{
    "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

​
Response

​
success
boolean
Indicates if the operation was successful
{
    "success": true
}

​
Status Codes

  • 200 - Picture updated successfully
  • 400 - Invalid parameters or missing base64 image
  • 401 - Unauthorized
  • 413 - Image too large
  • 500 - Internal server error

​
Usage Example

curl -X PUT https://api.wappfy.com.br/api/my-session/profile/picture \
  -H "Content-Type: application/json" \
  -d '{"picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="}'

​
Observations

  • The image must be in base64 format
  • Supported formats: JPG, PNG, GIF
  • It is recommended to use square images for better display
  • Recommended maximum size: 5MB

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) of the profile you want to update

Body

application/json
​
file
object
required

Response

200 - application/json
​
success
boolean
default:true
required