Update company list
curl --request PATCH \
--url https://app.tryspecter.com/api/v1/lists/companies/{listId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"add_ids": [
"60e71a727d096fb914087e9e"
],
"delete_ids": []
}
'import requests
url = "https://app.tryspecter.com/api/v1/lists/companies/{listId}"
payload = {
"add_ids": ["60e71a727d096fb914087e9e"],
"delete_ids": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({add_ids: ['60e71a727d096fb914087e9e'], delete_ids: []})
};
fetch('https://app.tryspecter.com/api/v1/lists/companies/{listId}', 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.tryspecter.com/api/v1/lists/companies/{listId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'add_ids' => [
'60e71a727d096fb914087e9e'
],
'delete_ids' => [
]
]),
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.tryspecter.com/api/v1/lists/companies/{listId}"
payload := strings.NewReader("{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.tryspecter.com/api/v1/lists/companies/{listId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tryspecter.com/api/v1/lists/companies/{listId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}"
response = http.request(request)
puts response.read_body{
"errorCode": "INVALID_LIST_UUID",
"message": "List id must be a valid UUID."
}{
"errorCode": "API_KEY_MISSING",
"message": "No API Key was presented on the header X-API-KEY"
}{
"errorCode": "NOT_PERMITTED",
"message": "You do not have permission to access this resource."
}{
"errorCode": "<string>",
"message": "<string>"
}{
"errorCode": "<string>",
"message": "<string>"
}Company Lists
Update company list
Adds and/or removes company IDs from an existing company list in a single request.
Free. This call does not consume credits.
What you need
A list ID (UUID) shared with the API, and the company IDs to add and/or remove.
Behaviour
- Provide
add_idsand/ordelete_ids; you can send either or both. - Operations run add-first-then-remove, so an ID in both ends up removed.
listIdmust be a UUID, otherwise400.- The list must be shared with the API to be modifiable.
What you do next
- Check the result. Pull the updated members with Get company list results.
PATCH
/
lists
/
companies
/
{listId}
Update company list
curl --request PATCH \
--url https://app.tryspecter.com/api/v1/lists/companies/{listId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"add_ids": [
"60e71a727d096fb914087e9e"
],
"delete_ids": []
}
'import requests
url = "https://app.tryspecter.com/api/v1/lists/companies/{listId}"
payload = {
"add_ids": ["60e71a727d096fb914087e9e"],
"delete_ids": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({add_ids: ['60e71a727d096fb914087e9e'], delete_ids: []})
};
fetch('https://app.tryspecter.com/api/v1/lists/companies/{listId}', 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.tryspecter.com/api/v1/lists/companies/{listId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'add_ids' => [
'60e71a727d096fb914087e9e'
],
'delete_ids' => [
]
]),
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.tryspecter.com/api/v1/lists/companies/{listId}"
payload := strings.NewReader("{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.tryspecter.com/api/v1/lists/companies/{listId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tryspecter.com/api/v1/lists/companies/{listId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"add_ids\": [\n \"60e71a727d096fb914087e9e\"\n ],\n \"delete_ids\": []\n}"
response = http.request(request)
puts response.read_body{
"errorCode": "INVALID_LIST_UUID",
"message": "List id must be a valid UUID."
}{
"errorCode": "API_KEY_MISSING",
"message": "No API Key was presented on the header X-API-KEY"
}{
"errorCode": "NOT_PERMITTED",
"message": "You do not have permission to access this resource."
}{
"errorCode": "<string>",
"message": "<string>"
}{
"errorCode": "<string>",
"message": "<string>"
}Authorizations
Path Parameters
The ID of the list being requested.
Body
application/json
Response
OK
Was this page helpful?
⌘I