Skip to main content
POST
Prepare a fixed TAM Preview

Body

application/json
request_id
string<uuid>
required

Keep this ID when repeating the same Preview request.

company_filters
TamCompanyFilters · object
required
contact_filters
TamContactFilters · object
exclude_companies_without_titles
boolean
default:false
tag_ids
string<uuid>[]
contact_tag_ids
string<uuid>[]
tag_existing_accounts
boolean
default:true

Add tag_ids to existing Accounts reused by this Import too. False tags only Accounts this Import creates; existing tags are always kept.

tag_existing_contacts
boolean
default:true

Add contact_tag_ids to existing Contacts reused by this Import too. False tags only Contacts this Import creates; existing tags are always kept.

qualifier_signal_id
string<uuid> | null

The Account AI field whose researched answer decides which companies pass. Any AI-filled Account field of this organization can be this run's Qualifier. Leave it empty to run no Qualifier.

qualifier_rule
TamQualifierRule · object | null

The passing answer for qualifier_signal_id, as {"operator": "equals", "value": …}. Rule operators: equals | contains (contains ignores case; use it for text and multi-select). A researched answer that does not pass the rule excludes the company and its people, the same as a failed or unanswered one; passing rows remain importable and Import writes each passing answer into the field. Required with qualifier_signal_id.

search_input
TamSearchPreviewInput · object | null

Exact Search criteria supplied by the caller for this Preview.

Response

Successful Response

data
TamPreviewResponse · object
required
meta
ResponseMeta · object