Start Enrich Job
curl --request POST \
--url https://api.example.com/api/enrich \
--header 'Content-Type: application/json' \
--data '
{
"salesNavUrl": "<string>",
"name": "<string>",
"sender": {
"sender.name": "<string>",
"sender.company": "<string>",
"sender.valueProp": "<string>"
}
}
'import requests
url = "https://api.example.com/api/enrich"
payload = {
"salesNavUrl": "<string>",
"name": "<string>",
"sender": {
"sender.name": "<string>",
"sender.company": "<string>",
"sender.valueProp": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
salesNavUrl: '<string>',
name: '<string>',
sender: {
'sender.name': '<string>',
'sender.company': '<string>',
'sender.valueProp': '<string>'
}
})
};
fetch('https://api.example.com/api/enrich', 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.example.com/api/enrich",
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([
'salesNavUrl' => '<string>',
'name' => '<string>',
'sender' => [
'sender.name' => '<string>',
'sender.company' => '<string>',
'sender.valueProp' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/enrich"
payload := strings.NewReader("{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/enrich")
.header("Content-Type", "application/json")
.body("{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"jobId": "<string>",
"listId": "<string>",
"status": "<string>"
}Endpoints
Start Enrich Job
Start a new Sales Navigator enrich and enrichment job
POST
/
api
/
enrich
Start Enrich Job
curl --request POST \
--url https://api.example.com/api/enrich \
--header 'Content-Type: application/json' \
--data '
{
"salesNavUrl": "<string>",
"name": "<string>",
"sender": {
"sender.name": "<string>",
"sender.company": "<string>",
"sender.valueProp": "<string>"
}
}
'import requests
url = "https://api.example.com/api/enrich"
payload = {
"salesNavUrl": "<string>",
"name": "<string>",
"sender": {
"sender.name": "<string>",
"sender.company": "<string>",
"sender.valueProp": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
salesNavUrl: '<string>',
name: '<string>',
sender: {
'sender.name': '<string>',
'sender.company': '<string>',
'sender.valueProp': '<string>'
}
})
};
fetch('https://api.example.com/api/enrich', 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.example.com/api/enrich",
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([
'salesNavUrl' => '<string>',
'name' => '<string>',
'sender' => [
'sender.name' => '<string>',
'sender.company' => '<string>',
'sender.valueProp' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/enrich"
payload := strings.NewReader("{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/enrich")
.header("Content-Type", "application/json")
.body("{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"salesNavUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"sender\": {\n \"sender.name\": \"<string>\",\n \"sender.company\": \"<string>\",\n \"sender.valueProp\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"jobId": "<string>",
"listId": "<string>",
"status": "<string>"
}Request Body
string
required
The full LinkedIn Sales Navigator search URL
string
Optional name for this list. Auto-generated from filters if not provided.
object
Request
curl -X POST https://api.cheetah-sales.dev/api/enrich \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"salesNavUrl": "https://www.linkedin.com/sales/search/people?query=...",
"sender": {
"name": "John Smith",
"company": "Acme Corp",
"valueProp": "We help companies automate sales outreach"
}
}'
const response = await fetch('https://api.cheetah-sales.dev/api/enrich', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
salesNavUrl: 'https://www.linkedin.com/sales/search/people?query=...',
sender: {
name: 'John Smith',
company: 'Acme Corp',
valueProp: 'We help companies automate sales outreach'
}
})
});
import requests
response = requests.post(
'https://api.cheetah-sales.dev/api/enrich',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
json={
'salesNavUrl': 'https://www.linkedin.com/sales/search/people?query=...',
'sender': {
'name': 'John Smith',
'company': 'Acme Corp',
'valueProp': 'We help companies automate sales outreach'
}
}
)
Response
boolean
Whether the request was successful
string
Unique job ID to check status. Starts with
run_string
UUID of the created list
string
Initial status (will be
pending)Response
{
"success": true,
"jobId": "run_cm5x8k9j0000108l4g2h5h3k2",
"listId": "550e8400-e29b-41d4-a716-446655440000",
"status": "pending",
"statusUrl": "/api/enrich/run_cm5x8k9j0000108l4g2h5h3k2"
}
