Skip to main content
PUT
/
api
/
{session}
/
profile
/
name
{
    "name": "John Silva"
}

{
    "success": true
}

​
Description

This endpoint allows you to update the profile display name of the user authenticated in the WhatsApp session. The name will be changed on the WhatsApp profile.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID

​
Request Body

​
name
string
required
New profile display name. This will be the name that other users will see on WhatsApp.
{
    "name": "John Silva"
}

​
Response

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

​
Status Codes

  • 200 - Name updated successfully
  • 400 - Invalid parameters or missing name
  • 401 - Unauthorized
  • 500 - Internal server error

​
Usage Example

curl -X PUT https://api.wappfy.com.br/api/my-session/profile/name \
  -H "Content-Type: application/json" \
  -d '{"name": "John Silva"}'

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
​
name
string
required
Example:

"My New Name"

Response

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