Skip to main content
POST
/
api
/
profile
/
account
/
:instance
Update account
curl --request POST \
  --url https://api.example.com/api/profile/account/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "profilePicture": "<string>",
  "profileName": "<string>",
  "profileStatus": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes (setting the same value again is a no-op)

​
Description

Updates one or more fields of the connected account’s profile: picture, display name (push name), and / or status (about). Partial update, at least one field must be sent. The updatedFields array in the response lists what was actually changed.

​
Examples

​
Everything

Updates all three profile fields in a single call: picture (public URL), display name (“João Silva”), and status (“Disponível”). The response lists which ones were actually changed in updatedFields. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": "https://example.com/photo.jpg",
    "profileName": "João Silva",
    "profileStatus": "Disponível"
  }'

​
Name only

Updates only profileName (push name) to “Vendas Empresa”. The current picture and status are left unchanged, the handler accepts partial updates. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profileName": "Vendas Empresa"
  }'

​
Base64 picture

Updates only the picture, sending the image inline as a data: URL with base64. The server decodes it, converts to JPEG 640x640, and applies it as the new profile picture. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
  }'

​
Remove picture

Send profilePicture: "" (empty string) to delete the current picture. The profile is left without an image, showing WhatsApp’s default avatar. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": ""
  }'

​
Success response

Returns a simple envelope with success, a fixed message (Profile updated successfully), and updatedFields, an array with the names of the fields actually changed (profilePicture, profileName, profileStatus). Use this array to confirm which updates went through, fields that were not sent or were ignored (e.g., empty profileName is a no-op) are left out of the list.
200 OK
{
  "success": true,
  "message": "Profile updated successfully",
  "updatedFields": ["profileName", "profileStatus"]
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json

​
Request body

At least one field is required.
​
profilePicture
string
URL or base64. An empty string ("") removes the current picture. Converted to JPEG (max 640×640).
​
profileName
string
Push name, the name displayed to other contacts.
​
profileStatus
string
Text shown in the “About” section. Can be an empty string to clear it.

​
Notes

  • profilePicture: "" removes the picture. profileName: "" is treated as a no-op. profileStatus: "" clears the status.
  • Picture URLs must be public, the server blocks downloads from internal networks (RFC1918, link-local) via SSRF guard.
  • Accepted formats: JPEG, PNG, WebP, GIF (first frame). Everything is converted to JPEG Q90 before upload.
  • The local cache (profile_name, profile_picture_url) is updated in the background, there may be a few seconds of lag.
  • Frequent changes may be rate-limited by WhatsApp.

​
Errors

HTTPMessage
400At least one field must be provided (profilePicture, profileName, or profileStatus)
400Instance is not connected to WhatsApp
500failed to process profile picture: <reason>
500failed to set profile picture: <reason>
500failed to set profile name: <reason>
500failed to set profile status: <reason>
Envelope: 
{
  "success": false,
  "error": { "message": "At least one field must be provided (profilePicture, profileName, or profileStatus)" }
}