Skip to main content
POST
/
async
cURL
curl --request POST \
  --url https://app.bettercontact.rocks/api/v2/async \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "data": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "company": "<string>",
      "company_domain": "<string>",
      "linkedin_url": "<string>",
      "custom_fields": {
        "uuid": "<string>",
        "list_name": "<string>"
      }
    }
  ],
  "enrich_email_address": true,
  "enrich_phone_number": true,
  "webhook": "<string>",
  "process_flow": "<string>"
}
'
import requests

url = "https://app.bettercontact.rocks/api/v2/async"

payload = {
"data": [
{
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"company_domain": "<string>",
"linkedin_url": "<string>",
"custom_fields": {
"uuid": "<string>",
"list_name": "<string>"
}
}
],
"enrich_email_address": True,
"enrich_phone_number": True,
"webhook": "<string>",
"process_flow": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
first_name: '<string>',
last_name: '<string>',
company: '<string>',
company_domain: '<string>',
linkedin_url: '<string>',
custom_fields: {uuid: '<string>', list_name: '<string>'}
}
],
enrich_email_address: true,
enrich_phone_number: true,
webhook: '<string>',
process_flow: '<string>'
})
};

fetch('https://app.bettercontact.rocks/api/v2/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.bettercontact.rocks/api/v2/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'company' => '<string>',
'company_domain' => '<string>',
'linkedin_url' => '<string>',
'custom_fields' => [
'uuid' => '<string>',
'list_name' => '<string>'
]
]
],
'enrich_email_address' => true,
'enrich_phone_number' => true,
'webhook' => '<string>',
'process_flow' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.bettercontact.rocks/api/v2/async"

payload := strings.NewReader("{\n \"data\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"<string>\",\n \"company_domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"custom_fields\": {\n \"uuid\": \"<string>\",\n \"list_name\": \"<string>\"\n }\n }\n ],\n \"enrich_email_address\": true,\n \"enrich_phone_number\": true,\n \"webhook\": \"<string>\",\n \"process_flow\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.bettercontact.rocks/api/v2/async")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"<string>\",\n \"company_domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"custom_fields\": {\n \"uuid\": \"<string>\",\n \"list_name\": \"<string>\"\n }\n }\n ],\n \"enrich_email_address\": true,\n \"enrich_phone_number\": true,\n \"webhook\": \"<string>\",\n \"process_flow\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.bettercontact.rocks/api/v2/async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"company\": \"<string>\",\n \"company_domain\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"custom_fields\": {\n \"uuid\": \"<string>\",\n \"list_name\": \"<string>\"\n }\n }\n ],\n \"enrich_email_address\": true,\n \"enrich_phone_number\": true,\n \"webhook\": \"<string>\",\n \"process_flow\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "id": "your-request-id",
  "message": "Processing..."
}
{
"error": "Unauthorized"
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Data to enrich

data
object[]
required

Array of leads to enrich. Minimum: 1 lead. Maximum: 100 leads.

enrich_email_address
boolean
required

If true, work email address of the contact will be enriched.

enrich_phone_number
boolean
required

If true, direct phone number of the contact will be enriched.

webhook
string

You can provide a webhook URL where results will be pushed once enrichment is done.

process_flow
string

Add the process flow ID to use for your enrichment, if subscribed to the process flow add-on.

Response

Enrichment task created

success
boolean
Example:

true

id
string
Example:

"your-request-id"

message
string
Example:

"Processing..."