Skip to content

Preview Lead Push

GET
/integrations/crm-sync/leads/push-preview

What a lead push would do, computed NOW and returned inline.

Nothing is written to the CRM. The asynchronous twin, POST /integrations/crm-sync/leads/previews, queues the same work and returns a job id instead - use that one for a population large enough that the inline version would time out.

Authorizations

Parameters

Query Parameters

connection_id
required

A Salesforce connection.

string

A Salesforce connection.

source_mode

Which population to preview. saved_segment requires audience_id; segments_union requires audience_ids.

string
default: all_qualified
Allowed values: all_qualified saved_segment segments_union all_contacts

Which population to preview. saved_segment requires audience_id; segments_union requires audience_ids.

audience_id
Any of:
integer

Required for saved_segment.

audience_ids
Any of:
Array<integer>

Required for segments_union.

limit

Ceiling on rows inspected.

integer
default: 10000 >= 1 <= 10000

Ceiling on rows inspected.

status_qualified
Any of:
string
status_unqualified
Any of:
string

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

What a lead push would do. Open-shaped - the readiness detail is per-provider and grows with it.

object
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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