Skip to content

Start Lead Preview

POST
/integrations/crm-sync/leads/previews

Queue a readiness preview and return a job id immediately.

Nothing is written to the CRM. Poll GET /integrations/crm-sync/jobs/{job_id} for the result, which carries the record count large_population_confirmed exists to acknowledge.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Queue a readiness preview of what a lead push WOULD do.

Nothing is written to the CRM. This is the call to make before /integrations/crm-sync/leads/push, and the only way to learn the record count that large_population_confirmed is acknowledging.

object
audience_id
Any of:
integer
audience_ids
Any of:
Array<integer>
connection_id
required

Which CRM connection to preview against.

string
large_population_confirmed
Any of:
boolean
page_size
Any of:
integer
>= 100 <= 10000
source_mode
Any of:
string
Allowed values: all_qualified saved_segment segments_union all_contacts
status_qualified
Any of:
string
status_unqualified
Any of:
string

Responses

202

Successful Response

object
data
required

A bulk job, or its status. Open-shaped - the payload carries per-provider progress detail that differs between CRMs and grows with them.

object
job_id
Any of:
string
status
Any of:
string
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string