curl --request PUT \
--url https://app.pipecorn.com/api/v2/lists/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"companies": [
{
"name": "Pipecorn",
"country_code": "FR",
"domain": "pipecorn.com",
"linkedin_url": "https://www.linkedin.com/company/pipecorn"
},
{
"name": "Google",
"country_code": "US",
"domain": "google.com",
"linkedin_url": "https://www.linkedin.com/company/google"
}
],
"webhook_url": "<string>",
"live": true
}
'import requests
url = "https://app.pipecorn.com/api/v2/lists/{id}"
payload = {
"companies": [
{
"name": "Pipecorn",
"country_code": "FR",
"domain": "pipecorn.com",
"linkedin_url": "https://www.linkedin.com/company/pipecorn"
},
{
"name": "Google",
"country_code": "US",
"domain": "google.com",
"linkedin_url": "https://www.linkedin.com/company/google"
}
],
"webhook_url": "<string>",
"live": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies: [
{
name: 'Pipecorn',
country_code: 'FR',
domain: 'pipecorn.com',
linkedin_url: 'https://www.linkedin.com/company/pipecorn'
},
{
name: 'Google',
country_code: 'US',
domain: 'google.com',
linkedin_url: 'https://www.linkedin.com/company/google'
}
],
webhook_url: '<string>',
live: true
})
};
fetch('https://app.pipecorn.com/api/v2/lists/{id}', 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.pipecorn.com/api/v2/lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companies' => [
[
'name' => 'Pipecorn',
'country_code' => 'FR',
'domain' => 'pipecorn.com',
'linkedin_url' => 'https://www.linkedin.com/company/pipecorn'
],
[
'name' => 'Google',
'country_code' => 'US',
'domain' => 'google.com',
'linkedin_url' => 'https://www.linkedin.com/company/google'
]
],
'webhook_url' => '<string>',
'live' => true
]),
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.pipecorn.com/api/v2/lists/{id}"
payload := strings.NewReader("{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.pipecorn.com/api/v2/lists/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pipecorn.com/api/v2/lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "Tech Companies 2024",
"id": "8e1dcba0-f0bb-4071-99fc-f18ba6559ccc",
"linkedin_id": "7123456789012345678",
"type": "companies",
"status": "ONGOING",
"companies_requested_count": 2,
"companies_found_count": 1,
"companies_not_found": [],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-02T00:00:00Z",
"companies": [
{
"linkedin_url": "https://www.linkedin.com/company/pipecorn",
"linkedin_id": "12345678",
"company_name": "Pipecorn",
"company_website": "https://pipecorn.com"
}
]
}Update a list
Appends companies to a list and restarts its import.
curl --request PUT \
--url https://app.pipecorn.com/api/v2/lists/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"companies": [
{
"name": "Pipecorn",
"country_code": "FR",
"domain": "pipecorn.com",
"linkedin_url": "https://www.linkedin.com/company/pipecorn"
},
{
"name": "Google",
"country_code": "US",
"domain": "google.com",
"linkedin_url": "https://www.linkedin.com/company/google"
}
],
"webhook_url": "<string>",
"live": true
}
'import requests
url = "https://app.pipecorn.com/api/v2/lists/{id}"
payload = {
"companies": [
{
"name": "Pipecorn",
"country_code": "FR",
"domain": "pipecorn.com",
"linkedin_url": "https://www.linkedin.com/company/pipecorn"
},
{
"name": "Google",
"country_code": "US",
"domain": "google.com",
"linkedin_url": "https://www.linkedin.com/company/google"
}
],
"webhook_url": "<string>",
"live": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies: [
{
name: 'Pipecorn',
country_code: 'FR',
domain: 'pipecorn.com',
linkedin_url: 'https://www.linkedin.com/company/pipecorn'
},
{
name: 'Google',
country_code: 'US',
domain: 'google.com',
linkedin_url: 'https://www.linkedin.com/company/google'
}
],
webhook_url: '<string>',
live: true
})
};
fetch('https://app.pipecorn.com/api/v2/lists/{id}', 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.pipecorn.com/api/v2/lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'companies' => [
[
'name' => 'Pipecorn',
'country_code' => 'FR',
'domain' => 'pipecorn.com',
'linkedin_url' => 'https://www.linkedin.com/company/pipecorn'
],
[
'name' => 'Google',
'country_code' => 'US',
'domain' => 'google.com',
'linkedin_url' => 'https://www.linkedin.com/company/google'
]
],
'webhook_url' => '<string>',
'live' => true
]),
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.pipecorn.com/api/v2/lists/{id}"
payload := strings.NewReader("{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.pipecorn.com/api/v2/lists/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pipecorn.com/api/v2/lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n {\n \"name\": \"Pipecorn\",\n \"country_code\": \"FR\",\n \"domain\": \"pipecorn.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/pipecorn\"\n },\n {\n \"name\": \"Google\",\n \"country_code\": \"US\",\n \"domain\": \"google.com\",\n \"linkedin_url\": \"https://www.linkedin.com/company/google\"\n }\n ],\n \"webhook_url\": \"<string>\",\n \"live\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "Tech Companies 2024",
"id": "8e1dcba0-f0bb-4071-99fc-f18ba6559ccc",
"linkedin_id": "7123456789012345678",
"type": "companies",
"status": "ONGOING",
"companies_requested_count": 2,
"companies_found_count": 1,
"companies_not_found": [],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-02T00:00:00Z",
"companies": [
{
"linkedin_url": "https://www.linkedin.com/company/pipecorn",
"linkedin_id": "12345678",
"company_name": "Pipecorn",
"company_website": "https://pipecorn.com"
}
]
}Authorizations
Your API key
Path Parameters
UUID of the list to update. A numeric LinkedIn (Sales Navigator) list ID is accepted too
Body
Companies to append to the list. Companies already in the list are not duplicated
Show child attributes
Show child attributes
[
{
"name": "Pipecorn",
"country_code": "FR",
"domain": "pipecorn.com",
"linkedin_url": "https://www.linkedin.com/company/pipecorn"
},
{
"name": "Google",
"country_code": "US",
"domain": "google.com",
"linkedin_url": "https://www.linkedin.com/company/google"
}
]
Replaces the list's webhook URL when present
true (default) also updates the LinkedIn Sales Navigator list, which requires valid LinkedIn credentials. false matches against the Pipecorn database only
Response
List updated
Name of the list
"Tech Companies 2024"
UUID of the list
"8e1dcba0-f0bb-4071-99fc-f18ba6559ccc"
ID of the LinkedIn Sales Navigator list, as a string. Empty when the list was created with live: false
"7123456789012345678"
What the list contains
companies, leads "companies"
Status of the list import
NOT_STARTED, ONGOING, FINISHED, ERROR, NOT_ENOUGH_CREDITS, FORBIDDEN, LIMIT_REACHED, UNAUTHORIZED, SCHEDULED "FINISHED"
Number of companies submitted (company lists only)
2
Number of companies matched so far (company lists only)
1
Names of the submitted companies that could not be matched, lowercased and trimmed (not the objects you submitted). Empty until the list is FINISHED (company lists only)
["google"]
"2024-01-01T00:00:00Z"
"2024-01-02T00:00:00Z"
Matched companies. null for lead lists
Show child attributes
Show child attributes
Was this page helpful?