API do Snov.io

Introdução

Os recursos de nosso serviço estão disponíveis com nossa API REST simples. Integre-se à API Snov.io para sincronizar seus processos de geração de leads. A API Snov.io permite recuperar endereços de e-mail de nosso banco de dados para domínios específicos, obter uma lista de todos os e-mails de um domínio específico, localizar endereços de e-mail por nome, sobrenome e domínio, além de verificar e-mails.

Atenção: a taxa de API é limitada a 60 solicitações por minuto.

Autenticação

Você precisa gerar um token de acesso para autenticar solicitações futuras. Ao fazer uma solicitação, especifique esse token de acesso no campo Autorização.

Authorization: Bearer QSlHffXmCAILIOHNGXToq4LsP2yX64VQhEBZ7Ei4

Aqui está um exemplo para geração de token.

Solicitação
POSThttps://app.snov.io/oauth/access_token
Parâmetros de entrada
grant_type
Será sempre "
client_credentials
"
client_id
Seu ID está disponível nas configurações da conta https://app.snov.io/api-setting
client_secret
Sua chave secreta está disponível nas configurações da conta https://app.snov.io/api-setting
Exemplos de código
<?php
function getAccessToken()
{
    $params = [
        'grant_type'    => 'client_credentials',
        'client_id'     => 'c57a0459f6t141659ea75cccb393c5111',
        'client_secret' => '77cbf92b71553e85ce3bfd505214f40b'
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/oauth/access_token',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res['access_token'];

}
?>
def get_access_token():
params = {
    'grant_type':'client_credentials',
    'client_id':'c57a0459f6t141659ea75cccb393c111',
    'client_secret': '77cbf92b71553e85ce3bfd505214f40b'
}

res = requests.post('https://app.snov.io/oauth/access_token', data=params)
resText = res.text.encode('ascii','ignore')

return json.loads(resText)['access_token']
Resposta
{
"access_token":"3yUyQZdks0Ej7T2fXzjUWzwlTcO4dWisKkeMpESz",
"token_type":"Bearer",
"expires_in":3600
}
Parâmetros de saída
access_token
Seu novo token de acesso
token_type
Será sempre Bearer
expires_in
Hora de expiração do token (em segundos)
Métodos de API
Contagem de e-mails

Gratuito

Com este método de API, você pode descobrir o número de endereços de e-mail de um determinado domínio em nosso banco de dados. É totalmente gratuito, então você não precisa de créditos para usá-lo!

Solicitação
POSThttps://app.snov.io/restapi/get-domain-emails-count
Parâmetros de entrada
domain
O nome do domínio para o qual você gostaria de saber o número de e-mails em nosso banco de dados.
Exemplos de código
<?php
function getEmailCount()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'domain'       => 'octagon.com',
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-domain-emails-count',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def get_email_count():
token = get_access_token()
params = {'access_token':token,
        'domain':'octagon.com'

}

res = requests.post('https://app.snov.io/restapi/get-domain-emails-count', data=params)

return json.loads(res.text)
Resposta
{
"domain":"octagon.com",
"webmail":false,
"result":1369
}
Parâmetros de saída
domain
O nome do domínio para o qual você gostaria de saber o número de e-mails em nosso banco de dados.
webmail
É "
true
" se o domínio que você está pesquisando for um webmail.
result
Um número total de endereços de e-mail que encontramos para este domínio. Como não podemos fornecer resultados para domínios de webmail, o resultado do webmail será sempre
0
.
Pesquisa de domínios

2 créditos por solicitação

Insira um nome de domínio e o Snov.io retornará todos os endereços de e-mail no domínio.
Se houver alguma informação adicional sobre o proprietário do e-mail disponível no banco de dados, nós a adicionaremos também.
Cada resposta retorna até 100 e-mails. Se não retornar pelo menos um e-mail, você não será cobrado pela solicitação.
Solicitação
POSThttps://app.snov.io/restapi/get-domain-emails-with-info
Parâmetros de entrada
domain
O nome do domínio a partir do qual você deseja localizar os endereços de e-mail. Por exemplo, "snov.io".
type
Pode conter valores diferentes -"
all
", "
personal
" ou "
generic
" . Um endereço de e-mail genérico é um endereço de e-mail baseado em uma função, por exemplo - contact@snov.io.

Um endereço de e-mail pessoal é o e-mail da pessoa que trabalha na empresa.

limit
Defina o limite para especificar o número de endereços de e-mail a serem retornados. Cada resposta retorna até 100 endereços de e-mail.
offset
Use o deslocamento para especificar o número de endereços de e-mail a serem ignorados na pesquisa. O padrão é
0
.
Exemplos de código
<?php
function getDomainSearch()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'domain'       => 'octagon.com',
        'type'         => 'all',
        'limit'        => 100
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-domain-emails-with-info',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def get_domain_search():
token = get_access_token()
params = {'access_token':token,
        'domain':'octagon.com',
          'type': 'all',
          'limit': 100
}

res = requests.post('https://app.snov.io/restapi/get-domain-emails-with-info', data=params)

return json.loads(res.text)
Resposta
{
"domain":"octagon.com",
"webmail":false,
"result":100,
"limit":100,
"companyName":"Octagon",
"emails":[
{
"email":"ben.gillespie@octagon.com",
"type":"prospect",
"status":"verified",
"firstName":"Ben",
"lastName":"Gillespie",
"position":"Senior Account Executive",
"sourcePage":"https://www.linkedin.com/pub/ben-gillespie/7/73/809"
},
...
]
}
Parâmetros de saída
domain
O nome de domínio para o qual a API forneceu os endereços de e-mail.
webmail
É "
true
" se o domínio que você está pesquisando for um webmail.
result
Um número de endereços de e-mail que encontramos para este domínio. Como não podemos fornecer resultados para domínios de webmail, o resultado do webmail será sempre
0
.
limit
Especifica o número máximo de endereços de e-mail a serem retornados.
companyName
O nome da empresa usado para encontrar os endereços de e-mail.
emails
A série de e-mails de domínio recuperados na pesquisa.
email
Um endereço de e-mail específico recuperado na pesquisa.
type
Pode conter "
prospect
" ou "
email
" valores. Se o tipo retornado for "
prospect
" , o Snov.io encontrou informações adicionais sobre o proprietário do e-mail.
status
Status de verificação do e-mail. O status pode ser "
verified
" ou "
notVerified
".
firstName
O nome do proprietário do e-mail.
lastName
O sobrenome do proprietário do e-mail.
position
O cargo atual do proprietário do e-mail.
sourcePage
A página de origem dos dados pessoais recuperados.
Verificador de e-mails

Gratuito

Verifique se os endereços de e-mail fornecidos são válidos e podem ser entregues. O endpoint da API retornará os resultados da verificação por e-mail. Se não tivermos verificado um determinado endereço de e-mail antes, os resultados não serão retornados a você. Nesse caso, a API retornará um identificador "not_verified" e você não receberá créditos por este e-mail. Você deve usar o Adicionar e-mails para verificação método para enviar este endereço de e-mail para verificação, após o qual você poderá obter os resultados da verificação de e-mail usando este endpoint.

Solicitação
POSThttps://app.snov.io/restapi/get-emails-verification-status
Parâmetros de entrada
emails
Os endereços de e-mail que você precisa verificar.
Exemplos de código
<?php
function getEmailVerifier()
{
    $token = getAccessToken();
    $emails = ['gavin.vanrooyen@octagon.com', 'lizi.hamer@octagon.com'];

    $emailsQuery = http_build_query(
        [
            'emails' => $emails
        ]
    );
    $params = ['access_token' => $token];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-emails-verification-status?' . $emailsQuery,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def get_email_verifier():
token = get_access_token()
params = {'access_token':token,
}

res = requests.post('https://app.snov.io/restapi/get-emails-verification-status?emails[]=gavin.vanrooyen@octagon.com&emails[]=lizi.hamer@octagon.com', data=params)

return json.loads(res.text)
Resposta
{
"gavin.vanrooyen@octagon.com":{
"status":{
"identifier":"not_verified",
"description":"Email is not verified, try to send it for verification"
},
"data":[
]
},
"lizi.hamer@octagon.com":{
"data":{
"email":"lizi.hamer@octagon.com",
"isValidFormat":true,
"isDisposable":false,
"isWebmail":true,
"isGibberish":false,
"smtpStatus":"valid"
},
"status":{
"identifier":"complete",
"description":"Email verification is completed"
}
}
}

Este método retornará dados para cada endereço de e-mail solicitado. A resposta contém um status de verificação de e-mail e os resultados da verificação.

Parâmetros de saída
status
O status de verificação do e-mail. Contém identificador e descrição.
identifier
Pode conter os seguintes valores: "
complete
", "
in_progress
", ou "
not_verified
". Se o identificador for "
not_verified
", "
data
" será vazio.
description
Aqui, você verá uma descrição do texto do status de verificação.
data
Contém mais resultados de verificação - "
email
", "
isValidFormat
", "
isWebmail
", "
isGibberish
".
email
O endereço de e-mail que foi verificado.
isValidFormat
É "
true
" se o formato do e-mail estiver correto, ou seja, se contiver símbolos válidos na ordem correta.
isDisposable
É "
true
" se acharmos que esse endereço de e-mail é de um serviço de e-mail descartável.
isWebmail
É "
true
" se este endereço de e-mail for de um webmail.
isGibberish
É "
true
" se este endereço de e-mail tiver sido gerado automaticamente.
smtpStatus
Pode retornar "
valid
", "
not_valid
" ou "
unknown
". Se o valor for "
unknown
", não podemos fornecer um status de SMTP para este endereço de e-mail.
Adicionar e-mails para verificação

0,5 crédito por endereço de e-mail

Se você nunca verificou um determinado endereço de e-mail antes, deve enviá-lo para verificação usando este método de API. Depois de executar esta ação, você poderá receber os resultados da verificação usando o Verificador de e-mails.

Solicitação
POSThttps://app.snov.io/restapi/add-emails-to-verification
Parâmetros de entrada
emails
Uma lista de endereços de e-mail que você precisa adicionar à fila de verificação. Cada solicitação pode conter até 10 e-mails.
Exemplos de código
<?php
function addEmailsForVerification()
{
    $token = getAccessToken();
    $emails = ['gavin.vanrooyen@octagon.com', 'lizi.hamer@octagon.com'];

    $emailsQuery = http_build_query(
        [
            'emails' => $emails
        ]
    );
    $params = ['access_token' => $token];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/add-emails-to-verification?' . $emailsQuery,
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def add_emails_for_verification():
token = get_access_token()
params = {'access_token': token
}

res = requests.post('https://app.snov.io/restapi/add-emails-to-verification?emails[]=gavin.vanrooyen@octagon.com&emails[]=lizi.hamer@octagon.com', data=params)

return json.loads(res.text)
Resposta
{
"gavin.vanrooyen@octagon.com":{
"sent":true
},
"lizi.hamer@octagon.com":{
"sent":true
}
}

Se um endereço de e-mail for adicionado com sucesso à fila, o método retornará "sent":true.

Localizador de e-mails

1 crédito por solicitação

Este método de API localiza endereços de e-mail usando o nome e o sobrenome da pessoa, e um nome de domínio. Se não tivermos esse endereço de e-mail em nosso banco de dados, não poderemos fornecer os resultados imediatamente. Para acelerar o processo, você pode usar o Adicionar nomes para localizar e-mails método para enviar este endereço de e-mail para pesquisa. Depois disso, tente o método do localizador de e-mails novamente.

Solicitação
POSThttps://app.snov.io/restapi/get-emails-from-names
Parâmetros de entrada
firstName
O nome do proprietário do endereço de e-mail.
lastName
O sobrenome do proprietário do endereço de e-mail.
domain
O nome do domínio da empresa que é usado no endereço de e-mail.
Exemplos de código
<?php
function getEmailFinder()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'domain'       => 'octagon.com',
        'firstName'    => 'gavin',
        'lastName'     => 'vanrooyen'
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-emails-from-names',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def get_email_finder():
token = get_access_token()
params = {'access_token':token,
          'domain':'octagon.com',
          'firstName': 'gavin',
          'lastName':'vanrooyen'
}

res = requests.post('https://app.snov.io/restapi/get-emails-from-names', data=params)

return json.loads(res.text)
Resposta
{
"params":{
"firstName":"gavin",
"lastName":"vanrooyen",
"domain":"octagon.com"
},
"data":{
"firstName":"gavin",
"lastName":"vanrooyen",
"emails":[
{
"email":"Gavin@octagon.com",
"emailStatus":"valid"
}
]
},
"status":{
"identifier":"complete",
"description":"Emails search is completed"
}
}
Parâmetros de saída
status
Use os valores neste objeto para detectar o status do processo.
identifier
Pode conter os seguintes valores: "
complete
", "
in_progress
", ou "
not_found
". Se o identificador for "
not_found
", a resposta conterá uma série de e-mails vazios.
description
Aqui, você verá uma descrição do texto do status de localização de e-mail.
data
Contém o resultado da pesquisa.
firstName
O nome do proprietário do endereço de e-mail.
lastName
O sobrenome do proprietário do endereço de e-mail.
emails
A série de endereços de e-mail com seus status. Valor "
emailStatus
" pode conter: "
valid
" ou "
unknown
".
Adicionar nomes para localizar e-mails

1 crédito por solicitação

Se o Snov.io não tiver os e-mails que você procura em seu banco de dados e não puder fornecer esses endereços por meio do Localizador de e-mails, você pode tentar enviar a solicitação de pesquisa de e-mails usando esse método. Se um e-mail for encontrado, você poderá coletá-lo usando o aplicativo gratuito Localizador de e-mails solicitar novamente.

Solicitação
POSThttps://app.snov.io/restapi/add-names-to-find-emails
Solicitação
firstName
O nome do proprietário do endereço de e-mail.
lastName
O sobrenome do proprietário do endereço de e-mail.
domain
O nome do domínio da empresa que é usado no endereço de e-mail.
Exemplos de código
<?php
function getAddNamesToFindEmails()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'domain'       => 'octagon.com',
        'firstName'    => 'gavin',
        'lastName'     => 'vanrooyen'
    ];


    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/add-names-to-find-emails',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def add_names_to_find_emails():
token = get_access_token()
params = {'access_token':token,
          'domain':'octagon.com',
          'firstName': 'gavin',
          'lastName':'vanrooyen'
}

res = requests.post('https://app.snov.io/restapi/add-names-to-find-emails', data=params)

return json.loads(res.text)
Resposta
{
"firstName":"gavin",
"lastName":"vanrooyen",
"domain":"octagon.com",
"sent":true
}

Se uma solicitação de e-mail for adicionada com êxito à fila, o método retornará "sent":true.

Obter perfil com e-mail

1 crédito por solicitação

Forneça um endereço de e-mail e o Snov.io retornará todas as informações de perfil conectadas ao proprietário do endereço de e-mail fornecido a partir do banco de dados.
Se não encontrarmos informações sobre o proprietário do e-mail em nosso banco de dados, você não será cobrado pela solicitação.
Solicitação
POSThttps://app.snov.io/restapi/get-profile-by-email
Parâmetros de entrada
email
O endereço de e-mail da pessoa para a qual você deseja encontrar informações adicionais.
Exemplos de código
<?php
function getProfileByEmail()
{
    $token = getAccessToken();

    $params = [
        'access_token'    => $token,
        'email'           => 'gavin.vanrooyen@octagon.com'
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-profile-by-email',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);
    
    return $res;

}
?>
def get_profile_by_email():
token = get_access_token()
params = {'access_token':token,
        'email':'gavin.vanrooyen@octagon.com'
}

res = requests.post('https://app.snov.io/restapi/get-profile-by-email', data=params)

return json.loads(res.text)
Resposta
{
"id": 301592,
"source": "linkedIn",
"name": "Lizi Hamer",
"firstName": "Lizi",
"lastName": "Hamer",
"logo": "https://app.snov.io/img/peoples/010fcf23c70dfa68d880545ec89a9215.jpg",
"industry": null,
"country": "Singapore",
"locality": "Singapore",
"social": [
    {
        "link": "https://www.linkedin.com/in/lizihamer/",
        "type": "linkedIn"
    },
    {
        "link": "https://twitter.com/LiziHamer",
        "type": "twitter"
    }
],
"currentJobs": [
    {
        "companyName": "Octagon",
        "position": "Regional Creative Director",
        "socialLink": "https://www.linkedin.com/company/165282",
        "site": "www.octagon.com",
        "locality": "Greater New York City Area",
        "state": "Connecticut",
        "city": "Stamford",
        "street": "290 Harbor Dr",
        "street2": "2nd Floor",
        "postal": "06902",
        "founded": "1983",
        "startDate": "2016-01-31",
        "endDate": null,
        "size": "1-10",
        "industry": "Marketing and Advertising",
        "companyType": "Public Company",
        "country": "United States"
    },
    {
        "companyName": "SisuGirls",
        "position": "Co Founder",
        "socialLink": "https://www.linkedin.com/company/3841118",
        "site": "http://www.sisugirls.org",
        "locality": null,
        "state": "SG",
        "city": "Singapore",
        "street": "33-03 Hong Leong Building",
        "street2": null,
        "postal": null,
        "founded": "2014",
        "startDate": "2015-07-31",
        "endDate": null,
        "size": "1-10",
        "industry": "Health, Wellness and Fitness",
        "companyType": null,
        "country": "Singapore"
    }
],
"previousJobs": [
    {
        "companyName": "Fusion Co-innovation Labs",
        "position": "Creative Entrepreneur",
        "socialLink": null,
        "site": null,
        "locality": null,
        "state": null,
        "city": null,
        "street": null,
        "street2": null,
        "postal": null,
        "founded": null,
        "startDate": "2013-05-31",
        "endDate": "2013-10-31",
        "size": null,
        "industry": null,
        "companyType": null,
        "country": null
    },
    {
        "companyName": "Russell Commission",
        "position": "Youth Advisory Board Member",
        "socialLink": null,
        "site": null,
        "locality": null,
        "state": null,
        "city": null,
        "street": null,
        "street2": null,
        "postal": null,
        "founded": null,
        "startDate": "2004-06-30",
        "endDate": "2006-06-30",
        "size": null,
        "industry": null,
        "companyType": null,
        "country": null
    }
],
"lastUpdateDate": "2018-02-07 10:12:28"
}
Parâmetros de saída
id
Um identificador de perfil exclusivo.
source
A fonte dos dados pessoais recuperados.
name
O nome completo do proprietário do endereço de e-mail.
firstName
O nome da pessoa.
lastName
O sobrenome da pessoa.
logo
A foto do perfil da pessoa.
industry
O setor da pessoa conforme indicado na fonte.
country
O país da pessoa conforme indicado na fonte.
locality
O local da pessoa conforme indicado na fonte.
social
Links para os perfis sociais da pessoa.
currentJobs
Uma matriz contendo informações sobre as posições de trabalho atuais da pessoa.
previousJobs
Uma matriz contendo informações sobre as posições de trabalho anteriores da pessoa.
lastUpdateDate
A data da última atualização do perfil no banco de dados.
Adicionar cliente potencial à lista

Gratuito

Adicione um cliente potencial a uma lista específica. Esse método será útil para quem deseja automatizar a adição de clientes potenciais às listas com campanhas de gotejamento por e-mail ativas. Dessa forma, após um cliente potencial ser adicionado automaticamente a uma lista escolhida, uma campanha de gotejamento por e-mail será iniciada automaticamente.

Solicitação
POSThttps://app.snov.io/restapi/add-prospect-to-list
Parâmetros de entrada
email
(necessário)
O endereço de e-mail do cliente potencial.
fullName
O nome completo do cliente potencial.
firstName
O nome do cliente potencial.
lastName
O sobrenome do cliente potencial.
country
O país do cliente potencial. Os nomes dos países são definidos aqui. Use apenas países desta lista.
locality
O local do cliente potencial.
position
O cargo do cliente potencial.
companyName
O nome da empresa do cliente potencial.
companySite
O site da empresa do cliente potencial. Use o
http://example.com
formato.
updateContact
Atualiza um cliente potencial existente. Pode conter "
true
", ou "
false
". Se"
true
" e já existe um cliente potencial com este endereço de e-mail em uma das listas, o sistema atualizará o perfil existente. Se "
false
" , o sistema não atualizará o perfil existente.
customFields[phone number]
Você pode adicionar seus próprios campos personalizados. Especifique o nome do campo personalizado entre [colchetes].
social[linkedin]
Um link para o perfil de rede social do cliente potencial. Especifique o nome da rede social entre [colchetes] (LinkedIn, Facebook ou Twitter).
listId
(necessário)
O identificador da lista ao qual o cliente potencial pertence.
Exemplos de código
<?php
function addProspectToList()
{
    $token = getAccessToken();

    $params = [
        'access_token'              => $token,
        'email'                     => 'john.doe@example.com',
        'fullName'                  => 'John Doe',
        'firstName'                 => 'John',
        'lastName'                  => 'Doe',
        'country'                   => 'United States',
        'locality'                  => 'Woodbridge, New Jersey',
        'social[linkedin]'          => 'https://www.linkedin.com/in/johndoe/&social',
        'social[twiiter]'           => 'https://twitter.com/johndoe&social',
        'customFields[phone number]'=> '+ 1 888 2073333',
        'position'                  => 'Vice President of Sales',
        'companyName'               => 'GoldenRule',
        'companySite'               => 'https://goldenrule.com',
        'updateContact'             => true,
        'listId'                    => '12345',
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/add-prospect-to-list',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);
    
    return $res;

}
?>
def add_prospect_to_list():
token = get_access_token()
params = {'access_token':token,
          'email':'john.doe@example.com',
          'fullName': 'John Doe',
          'firstName':'John',
          'lastName':'Doe',
          'country':'United States',
          'locality':'Woodbridge, New Jersey',
          'social[linkedin]':'https://www.linkedin.com/in/johndoe/&social',
          'social[twiiter]':'https://twitter.com/johndoe&social',
          'customFields[phone number]':'+ 1 888 2073333',
          'position':'Vice President of Sales',
          'companyName':'GoldenRule',
          'companySite':'https://goldenrule.com',
          'updateContact':1,
          'listId':'12345'
}

res = requests.post('https://app.snov.io/restapi/add-prospect-to-list', data=params)

return json.loads(res.text)
Resposta
{
    "success": true,
    "response": {
        "id": "0Y2QzowWL1rHpIptwaRp0Q==",
        "added": true,
        "updated": false,
        "errors": ""
    }
}
Parâmetros de saída
success
É "
true
" se o cliente potencial foi adicionado à lista com sucesso.
id
Identificador do cliente potencial adicionado.
added
É "
true
" se o cliente potencial foi adicionado à lista.
updated
É "
true
" se os dados existentes do cliente potencial foram atualizados.
errors
Houve um erro ao adicionar o cliente potencial à lista.
Localizar cliente potencial por ID

Gratuito

Localize clientes potenciais de suas listas por ID. Ao conhecer o ID de um cliente potencial específico, você pode obter informações completas sobre o cliente potencial, incluindo as listas e campanhas às quais ele foi adicionado.

Solicitação
POSThttps://app.snov.io/restapi/get-prospect-by-id
Parâmetros de entrada
Id
(necessário)
O ID do cliente potencial. Você pode vê-lo na resposta ao adicionar um cliente potencial por meio de Adicionar cliente potencial à lista Método de API ou no URL ao visualizar a página do cliente potencial (ver um exemplo).
Exemplos de código
<?php
function getProspectById()
{
    $token = getAccessToken();

    $params = [
        'access_token'    => $token,
        'id'           => 'xusD3-T_K5IktGoaa8Jc8A=='
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-prospect-by-id',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);
    
    return $res;

}
?>
def getProspectById():
token = get_access_token()
params = {'access_token':token,
        'id':'xusD3-T_K5IktGoaa8Jc8A=='
}

res = requests.post('https://app.snov.io/restapi/get-prospect-by-id', data=params)

return json.loads(res.text)
Resposta
{
  "success": true,
  "data": {
    "id": "xusD3-T_K5IktGoaa8Jc8A==",
    "name": "Gavin Vanrooyen",
    "firstName": "Gavin",
    "lastName": "Vanrooyen",
    "industry": "Entertainment",
    "country": "United States",
    "locality": "Greater Atlanta Area",
    "social": [
      {
        "link": "https:\/\/www.linkedin.com\/in\/gavin-vanrooyen-8090738\/",
        "type": "linkedIn"
      }
    ],
    "lastUpdateDate": {
      "date": "2019-09-11 12:37:58.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "currentJob": [
      {
        "companyName": "Octagon",
        "position": "Senior Brand Director",
        "socialLink": "https:\/\/www.linkedin.com\/company\/659312",
        "site": "http:\/\/octagon.com",
        "locality": "United States",
        "state": null,
        "city": null,
        "street": null,
        "street2": null,
        "postal": null,
        "founded": null,
        "startDate": "2018-07-31",
        "endDate": null,
        "size": "1-10",
        "industry": "Entertainment",
        "companyType": "Public Company",
        "country": "United States"
      }
    ],
    "previousJob": [
      {
        "companyName": "UPS",
        "position": "Manager, Sponsorships and Events",
        "socialLink": "https:\/\/www.linkedin.com\/company\/152322",
        "site": "http:\/\/www.ups.com\/",
        "locality": "United States",
        "state": "GA",
        "city": "Atlanta",
        "street": "55 Glenlake Parkway, NE",
        "street2": null,
        "postal": "30328",
        "founded": "1907",
        "startDate": null,
        "endDate": null,
        "size": "10001+",
        "industry": "Logistics and Supply Chain",
        "companyType": "Public Company",
        "country": "United States"
      }
    ],
    "lists": [
      {
        "id": 1250344,
        "name": "People List"
      }
    ],
    "campaigns": []
  }
}
Parâmetros de saída
success
É "
true
" se o cliente potencial foi encontrado
id
Identificador de perfil único
name
Nome completo do cliente potencial
firstName
Nome do cliente potencial
lastName
Sobrenome do cliente potencial
industry
Setor confirme indicado no perfil do cliente potencial
country
País do cliente potencial
locality
Local do cliente potencial
social
Links para os perfis sociais do cliente potencial
currentJobs
A série contém informações sobre o cargo atual do cliente potencial
previousJobs
A série contém informações sobre os cargos anteriores do cliente potencial
lastUpdateDate
Data da última atualização do perfil
lists
Lista à qual o cliente potencial foi adicionado
campaigns
Lista de campanhas às quais este cliente potencial foi adicionado como destinatário. Contém estatísticas curtas como status, número de mensagens enviadas, aberturas e respostas.
Localizar cliente potencial por e-mail

Gratuito

Encontre clientes potenciais de suas listas por endereço de e-mail. Ao pesquisar por e-mail, você recebe uma lista de todos os clientes potenciais vinculados a este endereço de e-mail. Cada elemento da lista contém informações completas sobre os clientes potenciais, incluindo as listas e campanhas às quais eles foram adicionados.

Solicitação
POSThttps://app.snov.io/restapi/get-prospect-by-email
Parâmetros de entrada
email
(necessário)
O endereço de e-mail do cliente potencial
Exemplos de código
<?php
function getProspectsByEmail()
{
    $token = getAccessToken();

    $params = [
        'access_token'    => $token,
        'email'           => 'gavin.vanrooyen@octagon.com'
    ];

    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/get-prospects-by-email',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);
    
    return $res;

}
?>
def getProspectsByEmail():
token = get_access_token()
params = {'access_token':token,
        'email':'gavin.vanrooyen@octagon.com'
}

res = requests.post('https://app.snov.io/restapi/get-prospects-by-email', data=params)

return json.loads(res.text)
Resposta
{
  "success": true,
  "data": [
    {
      "id": "xusD3-T_K5IktGoaa8Jc8A==",
      "name": "Gavin Vanrooyen",
      "firstName": "Gavin",
      "lastName": "Vanrooyen",
      "industry": "Entertainment",
      "country": "United States",
      "locality": "Greater Atlanta Area",
      "social": [
        {
          "link": "https:\/\/www.linkedin.com\/in\/gavin-vanrooyen-809073755\/",
          "type": "linkedIn"
        }
      ],
      "lastUpdateDate": {
        "date": "2019-09-11 12:37:58.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "currentJob": [
        {
          "companyName": "Octagon",
          "position": "Senior Brand Director",
          "socialLink": "https:\/\/www.linkedin.com\/company\/659333",
          "site": "http:\/\/octagon.com",
          "locality": "United States",
          "state": null,
          "city": null,
          "street": null,
          "street2": null,
          "postal": null,
          "founded": null,
          "startDate": "2018-07-31",
          "endDate": null,
          "size": "1-10",
          "industry": "Entertainment",
          "companyType": "Public Company",
          "country": "United States"
        }
      ],
      "previousJob": [
        {
          "companyName": "UPS",
          "position": "Manager, Sponsorships and Events",
          "socialLink": "https:\/\/www.linkedin.com\/company\/1523574",
          "site": "http:\/\/www.ups.com\/",
          "locality": "United States",
          "state": "GA",
          "city": "Atlanta",
          "street": "55 Glenlake Parkway, NE",
          "street2": null,
          "postal": "30328",
          "founded": "1907",
          "startDate": null,
          "endDate": null,
          "size": "10001+",
          "industry": "Logistics and Supply Chain",
          "companyType": "Public Company",
          "country": "United States"
        }
      ],
      "lists": [
        {
          "id": 1250344,
          "name": "People List"
        }
      ],
      "campaigns": []
    }
  ]
}
Parâmetros de saída
success
É "
true
" se o cliente potencial foi encontrado
id
Identificador de perfil único
name
Nome completo do cliente potencial
firstName
Nome do cliente potencial
lastName
Sobrenome do cliente potencial
industry
Setor confirme indicado no perfil do cliente potencial
country
País do cliente potencial
locality
Local do cliente potencial
social
Links para os perfis sociais do cliente potencial
currentJobs
A série contém informações sobre o cargo atual do cliente potencial
previousJobs
A série contém informações sobre os cargos anteriores do cliente potencial
lastUpdateDate
Data da última atualização do perfil
lists
Lista à qual o cliente potencial foi adicionado
campaigns
Lista de campanhas às quais este cliente potencial foi adicionado como destinatário. Contém estatísticas curtas como status, número de mensagens enviadas, aberturas e respostas.
Alterar status do destinatário

Gratuito

Altere o status de um destinatário em uma campanha específica.

Solicitação
POSThttps://app.snov.io/restapi/change-recipient-status
Parâmetros de entrada
email
(necessário)
O endereço de e-mail do cliente potencial.
campaign_id
(necessário)
O ID da campanha. Você pode encontrá-lo no URL ao visualizar as informações da campanha (show an example).
status
(necessário)
Novo status do destinatário. Pode conter Ativo, Pausado, Finalizado, Descadastrado, Respondido automaticamente, Respondido, Respondido de outro e-mail. Você não pode alterar o status dos destinatários se o status for Finalizado ou Movido.
Exemplos de código
<?php
function changeRecipientStatus()
{
    $token = getAccessToken();

    $params = [
        'access_token' => $token,
        'email'       => 'gavin.vanrooyen@octagon.com',
        'campaign_id'    => '179025',
        'status'     => 'Paused'
    ];


    $options = [
        CURLOPT_URL            => 'https://app.snov.io/restapi/change-recipient-status',
        CURLOPT_POST           => true,
        CURLOPT_POSTFIELDS     => $params,
        CURLOPT_RETURNTRANSFER => true
    ];

    $ch = curl_init();

    curl_setopt_array($ch, $options);

    $res = json_decode(curl_exec($ch), true);
    curl_close($ch);

    return $res;

}
?>
def change_recipient_status():
token = get_access_token()
params = {'access_token':token,
          'email':'gavin.vanrooyen@octagon.com',
          'campaign_id': '179025',
          'status':'Paused'
}

res = requests.post('https://app.snov.io/restapi/change-recipient-status', data=params)

return json.loads(res.text)
Resposta
{
  "success": true
}
Parâmetros de saída

O método retorna "success: true" se o status do possível cliente foi alterado com sucesso. Se ocorrer algum erro, o método retornará "success: false" e a descrição do erro.