Remove companies or people from a Ready Preview
curl --request POST \
--url https://api.monaco.com/v1/tam/preview/{preview_id}/exclude \
--header 'Content-Type: application/json' \
--data '
{
"company_ids": [
"<string>"
],
"person_ids": [
"<string>"
],
"member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_websites": [
"<string>"
]
}
'import requests
url = "https://api.monaco.com/v1/tam/preview/{preview_id}/exclude"
payload = {
"company_ids": ["<string>"],
"person_ids": ["<string>"],
"member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_websites": ["<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({
company_ids: ['<string>'],
person_ids: ['<string>'],
member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_websites: ['<string>']
})
};
fetch('https://api.monaco.com/v1/tam/preview/{preview_id}/exclude', 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.monaco.com/v1/tam/preview/{preview_id}/exclude",
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([
'company_ids' => [
'<string>'
],
'person_ids' => [
'<string>'
],
'member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_websites' => [
'<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.monaco.com/v1/tam/preview/{preview_id}/exclude"
payload := strings.NewReader("{\n \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<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.monaco.com/v1/tam/preview/{preview_id}/exclude")
.header("Content-Type", "application/json")
.body("{\n \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monaco.com/v1/tam/preview/{preview_id}/exclude")
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 \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PREPARING",
"request": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_filters": {
"account_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filtering_rules": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": null
}
],
"operator": "and"
},
"searching_rule": {
"value": "<string>"
}
},
"contact_filters": {
"include_keywords": [
"<string>"
],
"exclude_keywords": [
"<string>"
],
"seniority": "Individual Contributor",
"countries": [
"<string>"
]
},
"exclude_companies_without_titles": false,
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"contact_tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tag_existing_accounts": true,
"tag_existing_contacts": true,
"qualifier_signal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qualifier_rule": {
"value": true,
"operator": "equals"
},
"search_input": {
"filtering_rules": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": null
}
],
"operator": "and"
},
"title_enrichment": {
"condition": "or",
"criterias": []
},
"searching_rule": {
"value": "<string>"
},
"grouping_rule": {
"field": "<string>"
},
"sorting_rules": [],
"with_titles": false,
"title_search": [],
"exclude_companies_in_tam": false,
"max_candidates": 2,
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"pagination_meta": {
"current_page": 123,
"page_size": 123,
"total_pages": 123,
"total_count": 123
},
"exclusion": {
"excluded": {
"companies": 1,
"contacts": 1
},
"already_excluded": [
"<string>"
],
"unknown_ids": [
"<string>"
],
"unknown_websites": [
"<string>"
],
"companies_without_people": [
"<string>"
]
},
"tam_import_balance": {
"billing_mode": "platform",
"limited": true,
"period": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"kind": "calendar_month"
},
"accounts": {
"limit": 123,
"used": 1,
"remaining": 123,
"would_add": 123,
"after_import": 123,
"over_by": 123
},
"contacts": {
"limit": 123,
"used": 1,
"remaining": 123,
"would_add": 123,
"after_import": 123,
"over_by": 123
},
"exceeded": true
},
"result": {
"accounts": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"exclusions": {},
"duplicate_source_rows": 0
},
"contacts": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"exclusions": {},
"duplicate_source_rows": 0
},
"qualifier": {
"available": true,
"signal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"question": "<string>",
"data_type": "<string>",
"rule": {
"value": true,
"operator": "equals"
}
},
"reason": "<string>"
}
},
"members": [
{
"member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ordinal": 1,
"kind": "company",
"source_id": "<string>",
"selected": true,
"is_importable": true,
"data": {},
"company_id": "<string>",
"is_qualified": true,
"preparation_exclusion_reason": "<string>",
"is_duplicate_source_row": false,
"existing": true,
"exclusion_reason": "<string>",
"qualification": {}
}
],
"failure_reason": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totals": {
"companies": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"excluded": 1
},
"people": {
"matched": 1,
"eligible": 1,
"excluded": 1
}
},
"contacts_by_account": {
"new_accounts": {
"new": 1,
"existing": 1,
"total": 1
},
"existing_accounts": {
"new": 1,
"existing": 1,
"total": 1
}
},
"research": {
"status": "not_started",
"reason": "<string>",
"field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"question": "<string>",
"passed": 1,
"not_matched": 1,
"failed": 1,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"cost": {
"unit_product": "<string>",
"charged": true,
"companies": 123,
"units": 123,
"unit_rate": 123,
"estimated_ai_signal_credits": 123,
"actual_ai_signal_credits": 123,
"rate_basis": "list",
"charged_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}TAM
Remove companies or people from a Ready Preview
Remove members from a Ready Preview before Import. Name companies by website (company_websites removes every company row whose website is exactly that domain, compared without scheme, www or path) or by ID (company_ids removes that one row), and people by ID (person_ids) or rows by member_ids. A website matching no company of this Preview is listed in exclusion.unknown_websites. Removed members leave the eligible, new and existing counts and are listed under EXCLUDED_BY_USER; a removed company takes its people with it. Nothing is all or nothing: an ID the Preview does not have is skipped and listed in exclusion.unknown_ids, an ID already removed is listed in exclusion.already_excluded, and the other IDs are still removed; exclusion.excluded counts the companies and contacts this request removed. Each list takes at most 1,000 IDs per request. You cannot add members to a Preview: to add companies or people, start a new Preview. Once an Import is accepted for the Preview, its members are fixed and this returns 409.
POST
/
v1
/
tam
/
preview
/
{preview_id}
/
exclude
Remove companies or people from a Ready Preview
curl --request POST \
--url https://api.monaco.com/v1/tam/preview/{preview_id}/exclude \
--header 'Content-Type: application/json' \
--data '
{
"company_ids": [
"<string>"
],
"person_ids": [
"<string>"
],
"member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"company_websites": [
"<string>"
]
}
'import requests
url = "https://api.monaco.com/v1/tam/preview/{preview_id}/exclude"
payload = {
"company_ids": ["<string>"],
"person_ids": ["<string>"],
"member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"company_websites": ["<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({
company_ids: ['<string>'],
person_ids: ['<string>'],
member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
company_websites: ['<string>']
})
};
fetch('https://api.monaco.com/v1/tam/preview/{preview_id}/exclude', 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.monaco.com/v1/tam/preview/{preview_id}/exclude",
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([
'company_ids' => [
'<string>'
],
'person_ids' => [
'<string>'
],
'member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'company_websites' => [
'<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.monaco.com/v1/tam/preview/{preview_id}/exclude"
payload := strings.NewReader("{\n \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<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.monaco.com/v1/tam/preview/{preview_id}/exclude")
.header("Content-Type", "application/json")
.body("{\n \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monaco.com/v1/tam/preview/{preview_id}/exclude")
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 \"company_ids\": [\n \"<string>\"\n ],\n \"person_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"company_websites\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PREPARING",
"request": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_filters": {
"account_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filtering_rules": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": null
}
],
"operator": "and"
},
"searching_rule": {
"value": "<string>"
}
},
"contact_filters": {
"include_keywords": [
"<string>"
],
"exclude_keywords": [
"<string>"
],
"seniority": "Individual Contributor",
"countries": [
"<string>"
]
},
"exclude_companies_without_titles": false,
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"contact_tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tag_existing_accounts": true,
"tag_existing_contacts": true,
"qualifier_signal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qualifier_rule": {
"value": true,
"operator": "equals"
},
"search_input": {
"filtering_rules": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": null
}
],
"operator": "and"
},
"title_enrichment": {
"condition": "or",
"criterias": []
},
"searching_rule": {
"value": "<string>"
},
"grouping_rule": {
"field": "<string>"
},
"sorting_rules": [],
"with_titles": false,
"title_search": [],
"exclude_companies_in_tam": false,
"max_candidates": 2,
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"pagination_meta": {
"current_page": 123,
"page_size": 123,
"total_pages": 123,
"total_count": 123
},
"exclusion": {
"excluded": {
"companies": 1,
"contacts": 1
},
"already_excluded": [
"<string>"
],
"unknown_ids": [
"<string>"
],
"unknown_websites": [
"<string>"
],
"companies_without_people": [
"<string>"
]
},
"tam_import_balance": {
"billing_mode": "platform",
"limited": true,
"period": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"kind": "calendar_month"
},
"accounts": {
"limit": 123,
"used": 1,
"remaining": 123,
"would_add": 123,
"after_import": 123,
"over_by": 123
},
"contacts": {
"limit": 123,
"used": 1,
"remaining": 123,
"would_add": 123,
"after_import": 123,
"over_by": 123
},
"exceeded": true
},
"result": {
"accounts": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"exclusions": {},
"duplicate_source_rows": 0
},
"contacts": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"exclusions": {},
"duplicate_source_rows": 0
},
"qualifier": {
"available": true,
"signal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"question": "<string>",
"data_type": "<string>",
"rule": {
"value": true,
"operator": "equals"
}
},
"reason": "<string>"
}
},
"members": [
{
"member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ordinal": 1,
"kind": "company",
"source_id": "<string>",
"selected": true,
"is_importable": true,
"data": {},
"company_id": "<string>",
"is_qualified": true,
"preparation_exclusion_reason": "<string>",
"is_duplicate_source_row": false,
"existing": true,
"exclusion_reason": "<string>",
"qualification": {}
}
],
"failure_reason": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totals": {
"companies": {
"matched": 1,
"eligible": 1,
"new": 1,
"existing": 1,
"excluded": 1
},
"people": {
"matched": 1,
"eligible": 1,
"excluded": 1
}
},
"contacts_by_account": {
"new_accounts": {
"new": 1,
"existing": 1,
"total": 1
},
"existing_accounts": {
"new": 1,
"existing": 1,
"total": 1
}
},
"research": {
"status": "not_started",
"reason": "<string>",
"field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"question": "<string>",
"passed": 1,
"not_matched": 1,
"failed": 1,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"cost": {
"unit_product": "<string>",
"charged": true,
"companies": 123,
"units": 123,
"unit_rate": 123,
"estimated_ai_signal_credits": 123,
"actual_ai_signal_credits": 123,
"rate_basis": "list",
"charged_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}Path Parameters
Body
application/json
Preview members to remove before Import. Removing only: to add, start a new Preview.
IDs the Preview does not have are skipped and reported, never rejected. Each list takes at most 1,000 IDs per request; that limit only bounds the request size, so send a longer list as several requests.
Companies to remove, by the source_id of their company rows (the company IDs Search and the Preview return). Each company's people are removed with it.
Maximum array length:
1000People to remove, by the source_id of their person rows.
Maximum array length:
1000Rows to remove, by member_id. A company row takes its people with it.
Maximum array length:
1000Companies to remove, by website: every company row of this Preview whose website is exactly this domain (compared as lower-case domains without scheme, www or path, e.g. Brumley.com matches https://www.brumley.com). Each company's people are removed with it. Not a substring match.
Maximum array length:
1000