Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
privacy
/
description
Recado do perfil
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/description \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "visualizationType": "<string>"
}
'

​
Conceituação

Através deste método, é possível configurar quem pode ver o recado do seu perfil.
A blacklist (lista de contatos não permitidos) é diferente para cada configuração de privacidade.
Não é necessário reenviar o atributo contactsBlacklist com os contatos já adicionados. Esse parâmetro é somente para alterações na blacklist.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
visualizationType
string
obrigatório
Tipo de visualização: ALL (todos), NONE (ninguém), CONTACTS (apenas contatos) ou CONTACT_BLACKLIST (todos os contatos exceto os da blacklist)

​
Opcionais

​
contactsBlacklist
array
Lista de alterações na blacklist (apenas para tipo CONTACT_BLACKLIST)

​
Request Body

Visível para todos: 
{
  "visualizationType": "ALL"
}
Com blacklist: 
{
  "visualizationType": "CONTACT_BLACKLIST",
  "contactsBlacklist": [
    { "action": "add", "phone": "554411111111" },
    { "action": "remove", "phone": "554422222222" }
  ]
}

​
Response

​
200

{
  "success": true
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.