Saltar al contenido principal
POST
/
api
/
profile
/
account
/
:instance
Actualizar cuenta
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 o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí (establecer el mismo valor de nuevo no produce efecto)

​
Descripción

Actualiza uno o más campos del perfil de la cuenta conectada: foto, nombre visible (push name) y/o estado (acerca de). Actualización parcial, al menos un campo debe enviarse. El array updatedFields en la respuesta lista los campos que efectivamente cambiaron.

​
Ejemplos

​
Todo

Actualiza los tres campos del perfil en una sola llamada: foto (URL pública), nombre visible (“João Silva”) y estado (“Disponível”). La respuesta indica cuáles realmente cambiaron en 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"
  }'

​
Solo el nombre

Actualiza únicamente profileName (push name) a “Vendas Empresa”. La foto y el estado actuales se mantienen, el handler acepta actualizaciones parciales. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profileName": "Vendas Empresa"
  }'

​
Foto en base64

Actualiza solo la foto, enviando la imagen incrustada como URL data: con base64. El servidor la decodifica, la convierte a JPEG 640x640 y la aplica como nueva foto de perfil. 
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=="
  }'

​
Eliminar foto

Envía profilePicture: "" (cadena vacía) para borrar la foto actual. El perfil queda sin imagen, mostrando el avatar predeterminado de WhatsApp. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": ""
  }'

​
Respuesta exitosa

Devuelve un envoltorio simple con success, un message fijo (Profile updated successfully) y updatedFields, un array con los nombres de los campos efectivamente cambiados (profilePicture, profileName, profileStatus). Usa este array para confirmar qué actualizaciones surtieron efecto, los campos que no se enviaron o que fueron ignorados (por ejemplo, profileName vacío es un no-op) quedan fuera de la lista.
200 OK
{
  "success": true,
  "message": "Profile updated successfully",
  "updatedFields": ["profileName", "profileStatus"]
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

Se requiere al menos un campo.
​
profilePicture
string
URL o base64. Una cadena vacía ("") elimina la foto actual. Convertida a JPEG (máx. 640×640).
​
profileName
string
Push name, el nombre que se muestra a otros contactos.
​
profileStatus
string
Texto mostrado en la sección “Acerca de”. Puede ser una cadena vacía para limpiarlo.

​
Notas

  • profilePicture: "" elimina la foto. profileName: "" se trata como un no-op. profileStatus: "" limpia el estado.
  • Las URLs de fotos deben ser públicas, el servidor bloquea descargas desde redes internas (RFC1918, link-local) mediante una protección SSRF.
  • Formatos aceptados: JPEG, PNG, WebP, GIF (primer cuadro). Todo se convierte a JPEG Q90 antes de la subida.
  • La caché local (profile_name, profile_picture_url) se actualiza en segundo plano, puede haber unos segundos de retraso.
  • Cambios frecuentes pueden ser limitados por WhatsApp.

​
Errores

HTTPMensaje
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>
Envoltorio: 
{
  "success": false,
  "error": { "message": "At least one field must be provided (profilePicture, profileName, or profileStatus)" }
}