Pular para o conteúdo principal
POST
/
api
/
profile
/
account
/
:instance
Atualizar conta
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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim (setar o mesmo valor de novo e no-op)

​
Descrição

Atualiza um ou mais campos do perfil da conta conectada: foto, nome de exibição (push name) e / ou status (about). Update parcial, pelo menos um campo deve ser enviado. A updatedFields na resposta lista o que foi efetivamente alterado.

​
Exemplos

​
Tudo

Atualiza os três campos do perfil em uma única chamada: foto (URL pública), nome de exibição (“João Silva”) e status (“Disponível”). A resposta lista quais foram efetivamente alterados em updatedFields. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": "https://exemplo.com/foto.jpg",
    "profileName": "João Silva",
    "profileStatus": "Disponível"
  }'

​
Só nome

Atualiza apenas o profileName (push name) para “Vendas Empresa”. Foto e status atuais ficam inalterados, o handler aceita update parcial. 
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 base64

Atualiza apenas a foto, enviando a imagem inline como data: URL com base64. O servidor decodifica, converte para JPEG 640x640 e aplica como nova 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=="
  }'

​
Remover foto

Envia profilePicture: "" (string vazia) para apagar a foto atual. O perfil fica sem imagem, exibindo o avatar padrão do WhatsApp. 
curl -X POST "https://ryzeapi.cloud/api/profile/account/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePicture": ""
  }'

​
Resposta de sucesso

Retorna um envelope simples com success, message fixa (Profile updated successfully) e updatedFields, um array com os nomes dos campos efetivamente alterados (profilePicture, profileName, profileStatus). Use esse array para confirmar quais updates passaram, campos não enviados ou ignorados (ex.: profileName vazio é no-op) ficam de fora da lista.
200 OK
{
  "success": true,
  "message": "Profile updated successfully",
  "updatedFields": ["profileName", "profileStatus"]
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

Pelo menos um campo obrigatório.
​
profilePicture
string
URL ou base64. String vazia ("") remove a foto atual. Convertida para JPEG (máx 640×640).
​
profileName
string
Push name, nome exibido aos outros contatos.
​
profileStatus
string
Texto da seção “Recados” (about). Pode ser string vazia para limpar.

​
Notas

  • profilePicture: "" remove a foto. profileName: "" é tratado como no-op. profileStatus: "" limpa o status.
  • URLs de foto devem ser públicas, o servidor bloqueia downloads de redes internas (RFC1918, link-local) por SSRF guard.
  • Formatos aceitos: JPEG, PNG, WebP, GIF (primeiro frame). Tudo vira JPEG Q90 antes de subir.
  • O cache local (profile_name, profile_picture_url) é atualizado em background, pode haver alguns segundos de defasagem.
  • Mudanças frequentes podem ser rate-limitadas pelo WhatsApp.

​
Erros

HTTPMensagem
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)" }
}