Pular para o conteúdo principal
PATCH
/
wa
/
instances
/
{instance_id}
/
profile
Atualização de Perfil
curl --request PATCH \
  --url https://api.example.com/wa/instances/{instance_id}/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "about": "Eu não mato com minha arma, aquele que mata com sua arama esqueceu o rosto do seu pai. Eu mato com o coração! ⚔️\n",
  "name": "Minha Instância",
  "profile_picture": "<string>"
}
'
{
  "about": "Hey there, I'm using WhatsApp",
  "id": "551112341234",
  "name": "Minha Instância",
  "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
}
Utilize este endpoint para atualizar os campos name (Nome), profile_picture (Foto de perfil) e/ou about (Descrição do perfil) no perfil do usuário. Todas as atualizações são opcionais, ou seja, apenas as informações presentes no corpo da requisição serão alteradas.

​
Comportamento

Se você enviar apenas uma ou duas informações, apenas esses campos serão atualizados. Campos não incluídos na requisição permanecerão inalterados.
Nota: Em alguns casos, a atualização do nome do perfil pode falhar. Estamos continuamente trabalhando para melhorar este comportamento, porém, há dependências externas que podem afetar o sucesso da operação.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
instance_id
string
obrigatório

ID da instância.

Corpo

application/json
​
about
string

Descrição sobre o perfil da instância, geralmente quando se cria um novo Whatsapp, vem configurado com uma mensagem padrão como esta: "Hey there, I'm using WhatsApp".

Exemplo:

"Eu não mato com minha arma, aquele que mata com sua arama esqueceu o rosto do seu pai. Eu mato com o coração! ⚔️\n"

​
name
string

Nome do perfil do Whatsapp

Exemplo:

"Minha Instância"

​
profile_picture
string<uri>

Foto de perfil, pode ser uma string no formato base64 ou uma url (publicamente acessível).

Resposta

200 - application/json

Success

​
about
string
obrigatório

Descrição do perfil da instância. Pode ser encontrado nos dispositivos em Configurações > Sobre.

Exemplo:

"Hey there, I'm using WhatsApp"

​
id
string
obrigatório

ID / número da instância retornado pelo Whatsapp.

Exemplo:

"551112341234"

​
name
string
obrigatório

ID usado para depuração interna

Exemplo:

"Minha Instância"

​
profile_picture
string<uri> | null
obrigatório

URL para foto de perfil da instância, caso inexistente retornará null.

Exemplo:

"https://zapsterapi.s3.us-east-1.amazonaws.com/..."