PATCH
/
wa
/
instances
/
{instance_id}
/
profile

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.

Authorizations

Authorization
string
headerrequired

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

Path Parameters

instance_id
string
required

ID da instância.

Body

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".

name
string

Nome do perfil do Whatsapp

profile_picture
string

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

Response

200 - application/json
about
string
required

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

id
string
required

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

name
string
required

ID usado para depuração interna

profile_picture
string | null
required

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