Visão Geral

Auth: TokenAccount ou TokenInstance em todas as rotas. Cada chamada valida a ownership da instância. Esta seção cobre as rotas /api/profile/* para atualizar o próprio perfil, consultar perfis de terceiros e ler / atualizar configurações de privacidade do WhatsApp.

Endpoints

Método	Path	Função
POST	`/api/profile/account/:instance`	Atualizar foto / nome / status
GET	`/api/profile/getAccount/:instance`	Obter perfil próprio ou de terceiro
GET	`/api/profile/getPrivacy/:instance`	Obter privacidade
GET	`/api/profile/privacy/:instance`	Alias de `/getPrivacy`
POST	`/api/profile/privacy/:instance`	Atualizar privacidade

Estrutura de privacidade

A API agrupa as configurações em três subobjetos: visibility, privacy e permissions.

{
  "visibility": {
    "lastSeen": "contacts",
    "status": "all",
    "profile": "contacts",
    "online": "match_last_seen"
  },
  "privacy": {
    "readReceipts": "all"
  },
  "permissions": {
    "callAdd": "all",
    "groupAdd": "contacts"
  }
}

Valores aceitos por campo

Campo	Valores
`lastSeen` / `status` / `profile`	`all` / `contacts` / `contact_blacklist` / `none`
`online`	`all` / `match_last_seen`
`readReceipts`	`all` / `none`
`callAdd`	`all` / `known`
`groupAdd`	`all` / `contacts` / `contact_blacklist`

Modelo `AccountProfileData`

Resposta de GET /getAccount:

{
  "profilePicture": "https://pps.whatsapp.net/...",
  "profileName": "João Silva",
  "profileStatus": "Disponivel",
  "phoneNumber": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net",
  "lid": "199789077627112@lid"
}

Envelope de erro

{
  "success": false,
  "error": { "message": "At least one field must be provided (profilePicture, profileName, or profileStatus)" }
}

Quadro de erros (resumo)

Categoria	Mensagem
Validação	`At least one field must be provided (profilePicture, profileName, or profileStatus)`
Validação	`At least one privacy setting must be provided`
Validação	`Invalid <field> value: <value>. Valid values: ...`
Estado	`Instance is not connected to WhatsApp`
Número	`Number not found or not registered on WhatsApp`
Número	`invalid LID format`
Falha	`failed to update <field> privacy: <reason>`

Atualizar conta

Mudar foto, nome de exibição ou status.

Atualizar privacidade

Ajustar quem vê o que.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Endpoints

Estrutura de privacidade

Valores aceitos por campo

Modelo `AccountProfileData`

Envelope de erro

Quadro de erros (resumo)

Próximo

Atualizar conta

Atualizar privacidade

​Endpoints

​Estrutura de privacidade

​Valores aceitos por campo

​Modelo AccountProfileData

​Envelope de erro

​Quadro de erros (resumo)

​Próximo

Atualizar conta

Atualizar privacidade

Endpoints

Estrutura de privacidade

Valores aceitos por campo

Modelo `AccountProfileData`

Envelope de erro

Quadro de erros (resumo)

Próximo