Create Enrichment Job

Create enrichment job

curl -X POST https://api.example.com/enrichments \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
        "name": "Sample Upload",
        "operator": "OR",
        "columns": ["EMAIL", "FIRST_NAME", "LAST_NAME", "PHONE"],
        "records": [
          {
            "first_name": "Harper",
            "last_name": "Nguyen",
            "phone": "+12145550123",
            "email": "harper.nguyen@example.com"
          },
          {
            "first_name": "Liam",
            "last_name": "Carter",
            "phone": "+18305550987",
            "email": "liam.carter@example.com"
          }
        ]
      }'

import requests

url = "https://api.audiencelab.io/enrichments"

payload = {
    "name": "Sample Upload",
    "operator": "OR",
    "columns": ["EMAIL", "FIRST_NAME", "LAST_NAME", "PHONE"],
    "records": [
        {
            "first_name": "Harper",
            "last_name": "Nguyen",
            "phone": "+12145550123",
            "email": "harper.nguyen@example.com"
        },
        {
            "first_name": "Liam",
            "last_name": "Carter",
            "phone": "+18305550987",
            "email": "liam.carter@example.com"
        }
    ]
}
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({
    name: 'Sample Upload',
    operator: 'OR',
    columns: ['EMAIL', 'FIRST_NAME', 'LAST_NAME', 'PHONE'],
    records: [
      {
        first_name: 'Harper',
        last_name: 'Nguyen',
        phone: '+12145550123',
        email: 'harper.nguyen@example.com'
      },
      {
        first_name: 'Liam',
        last_name: 'Carter',
        phone: '+18305550987',
        email: 'liam.carter@example.com'
      }
    ]
  })
};

fetch('https://api.audiencelab.io/enrichments', 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://api.audiencelab.io/enrichments",
  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([
    'name' => 'Sample Upload',
    'operator' => 'OR',
    'columns' => [
        'EMAIL',
        'FIRST_NAME',
        'LAST_NAME',
        'PHONE'
    ],
    'records' => [
        [
                'first_name' => 'Harper',
                'last_name' => 'Nguyen',
                'phone' => '+12145550123',
                'email' => 'harper.nguyen@example.com'
        ],
        [
                'first_name' => 'Liam',
                'last_name' => 'Carter',
                'phone' => '+18305550987',
                'email' => 'liam.carter@example.com'
        ]
    ]
  ]),
  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://api.audiencelab.io/enrichments"

	payload := strings.NewReader("{\n  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\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://api.audiencelab.io/enrichments")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.audiencelab.io/enrichments")

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  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "399e88c3-3263-4d9a-826c-437ef57f7b6c",
  "status": "IN_QUEUE"
}

{
  "message": "error message"
}

{
  "message": "error message"
}

{
  "message": "error message"
}

POST

enrichments

Create enrichment job

curl -X POST https://api.example.com/enrichments \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
        "name": "Sample Upload",
        "operator": "OR",
        "columns": ["EMAIL", "FIRST_NAME", "LAST_NAME", "PHONE"],
        "records": [
          {
            "first_name": "Harper",
            "last_name": "Nguyen",
            "phone": "+12145550123",
            "email": "harper.nguyen@example.com"
          },
          {
            "first_name": "Liam",
            "last_name": "Carter",
            "phone": "+18305550987",
            "email": "liam.carter@example.com"
          }
        ]
      }'

import requests

url = "https://api.audiencelab.io/enrichments"

payload = {
    "name": "Sample Upload",
    "operator": "OR",
    "columns": ["EMAIL", "FIRST_NAME", "LAST_NAME", "PHONE"],
    "records": [
        {
            "first_name": "Harper",
            "last_name": "Nguyen",
            "phone": "+12145550123",
            "email": "harper.nguyen@example.com"
        },
        {
            "first_name": "Liam",
            "last_name": "Carter",
            "phone": "+18305550987",
            "email": "liam.carter@example.com"
        }
    ]
}
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({
    name: 'Sample Upload',
    operator: 'OR',
    columns: ['EMAIL', 'FIRST_NAME', 'LAST_NAME', 'PHONE'],
    records: [
      {
        first_name: 'Harper',
        last_name: 'Nguyen',
        phone: '+12145550123',
        email: 'harper.nguyen@example.com'
      },
      {
        first_name: 'Liam',
        last_name: 'Carter',
        phone: '+18305550987',
        email: 'liam.carter@example.com'
      }
    ]
  })
};

fetch('https://api.audiencelab.io/enrichments', 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://api.audiencelab.io/enrichments",
  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([
    'name' => 'Sample Upload',
    'operator' => 'OR',
    'columns' => [
        'EMAIL',
        'FIRST_NAME',
        'LAST_NAME',
        'PHONE'
    ],
    'records' => [
        [
                'first_name' => 'Harper',
                'last_name' => 'Nguyen',
                'phone' => '+12145550123',
                'email' => 'harper.nguyen@example.com'
        ],
        [
                'first_name' => 'Liam',
                'last_name' => 'Carter',
                'phone' => '+18305550987',
                'email' => 'liam.carter@example.com'
        ]
    ]
  ]),
  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://api.audiencelab.io/enrichments"

	payload := strings.NewReader("{\n  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\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://api.audiencelab.io/enrichments")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.audiencelab.io/enrichments")

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  \"name\": \"Sample Upload\",\n  \"operator\": \"OR\",\n  \"columns\": [\n    \"EMAIL\",\n    \"FIRST_NAME\",\n    \"LAST_NAME\",\n    \"PHONE\"\n  ],\n  \"records\": [\n    {\n      \"first_name\": \"Harper\",\n      \"last_name\": \"Nguyen\",\n      \"phone\": \"+12145550123\",\n      \"email\": \"harper.nguyen@example.com\"\n    },\n    {\n      \"first_name\": \"Liam\",\n      \"last_name\": \"Carter\",\n      \"phone\": \"+18305550987\",\n      \"email\": \"liam.carter@example.com\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "399e88c3-3263-4d9a-826c-437ef57f7b6c",
  "status": "IN_QUEUE"
}

{
  "message": "error message"
}

{
  "message": "error message"
}

{
  "message": "error message"
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

name

string

required

Example:

"Prospect Upload"

records

object[]

required

Show child attributes

Example:

[
  {
    "first_name": "Ava",
    "last_name": "Stone",
    "phone": "+12145550123",
    "email": "ava.stone@example.com"
  },
  {
    "first_name": "Noah",
    "last_name": "Reed",
    "phone": "+18305559876",
    "email": "noah.reed@example.com"
  }
]

operator

enum<string>

default:OR

Available options:

AND,

OR

Example:

"OR"

columns

string[]

Optional explicit list of fields included in each record.

Accepted values

EMAIL
PERSONAL_EMAIL
BUSINESS_EMAIL
FIRST_NAME
LAST_NAME
PHONE
PERSONAL_ADDRESS
PERSONAL_CITY
PERSONAL_STATE
PERSONAL_ZIP
COMPANY_NAME
COMPANY_DOMAIN
COMPANY_INDUSTRY
SHA256_PERSONAL_EMAIL
LINKEDIN_URL
UP_ID
JOB_TITLE

Example:

["EMAIL", "FIRST_NAME", "LAST_NAME", "PHONE"]

Response

Enrichment job accepted

jobId

string

Example:

"399e88c3-3263-4d9a-826c-437ef57f7b6c"

status

string

Example:

"IN_QUEUE"

Audience

Enrichment

Pixel

Create Enrichment Job

Authorizations

Body

Response