Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
contacts
/
add
Adicionar contatos
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/contacts/add \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "phone": "<string>"
}
'

​
Conceituação

Este método é responsável por salvar os contatos do WhatsApp em sua lista de contatos no celular.
Sobre esse recursoO método para adicionar contatos à lista do WhatsApp só funcionará para contas que já receberam a atualização necessária. Certifique-se de que sua conta do WhatsApp tenha recebido a atualização antes de utilizar este recurso. Caso contrário, a operação não será concluída com sucesso.Além disso, é necessário permitir que o WhatsApp adicione contatos diretamente no celular. Para isso, vá até as configurações de privacidade do seu aplicativo e ajuste as permissões de forma que o WhatsApp possa acessar e modificar seus contatos.

​
Exemplo nas configurações

​
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

​
firstName
string
obrigatório
Nome do contato que vai ser adicionado na agenda
​
phone
string
obrigatório
Número do contato que vai ser adicionado na agenda

​
Opcionais

​
lastName
string
Sobrenome do contato que vai ser adicionado na agenda

​
Request Body

[
  {
    "firstName": "Contato 1",
    "lastName": "Sobrenome 1",
    "phone": "554499999999"
  },
  {
    "firstName": "Contato 2",
    "lastName": "Sobrenome 2",
    "phone": "554499998888"
  }
]

​
Response

​
200

{
  "success": true,
  "errors": []
}

​
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”.