API

Autorização

---

Para utilização de todas as APIs é necessário colocar no Header sua x-api-key.

Acesse seu perfil e selecione Token, sua Chave de API será apresentada. Dúvidas acesse o link Journey - Token

URL

URL Produção: https://app.vya.digital

Respostas padroes

{
    "status": false,
    "error": 1,
    "message": "Usuário não autorizado"
}

{
    "status": false,
    "erro": 1,
    "message": "Campo Telefone não está preenchido"
}

Messages

---

SMS

Enviar mensagens por SMS.

Acesse a documentação no link: https://app.vya.digital/api/docs

WhatsApp Business

Enviar mensagens por WhatsApp Business.

Acesse a documentação no link: https://app.vya.digital/api/docs

Contacts

---

Criar Contato

Acesse a documentação no link: https://app.vya.digital/api/docs

---

Atualizar Contato

Atualiza um contato.

Endpoint:

Method: PATCH
Type: RAW
URL: {{baseUrl}}/api/v2/contact

Headers:

Key	Value
x-api-key	{{apiKey}}

Body:

{
    "codigoAcao": "Codigo coletado no momento que foi criado o contato",
    "codigoContato": "Codigo coletado no momento que foi criado o contato",
    "nome": "Teste Paulo",
    "cpfcnpj": "99999999999",
    "telefone": "11912341234",
    "email": "teste@gmail.com"
}

Obs: Os campos do contato podem ter nomes diferentes, porque cada campanha exige propriedades particulares.

Response:

Success - 200 OK

{
    "status": true,
    "error": 0,
    "message": "Atualização realizada com sucesso"
}