Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
two-fa-code
Cadastrar código PIN
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/security/two-fa-code \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'
{
  "success": true
}

Conceituação

Método utilizado para cadastrar um código PIN de segurança na sua conta do WhatsApp.
Essa API está disponível apenas para instâncias mobile.

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.

Body

code
string
obrigatório
Código PIN a ser cadastrado

Request Body

{
  "code": "123456"
}

Response

200

success
boolean
Retorna true caso o código PIN tenha sido cadastrado com sucesso
{
  "success": true
}

400

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado.

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