Skip to content

Push All Leads

POST
/integrations/crm-sync/leads/push

Push graph8 people into Salesforce as Leads. THIS WRITES TO THEIR SYSTEM.

Returns a job - the work happens in the background. Poll GET /integrations/crm-sync/jobs/{job_id}.

Over the app’s population threshold the JOB is refused unless large_population_confirmed is true - the request itself is still a 202, and the refusal is what the job’s status reports. Run POST /integrations/crm-sync/leads/previews first to learn the count you would be acknowledging.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Push graph8 people into Salesforce as first-class Leads.

Salesforce is the CRM that distinguishes a Lead from a Contact; the other providers do not, which is why this is a separate surface from /integrations/crm-sync/contacts/push rather than an entity_type on it.

object
audience_id
Any of:
integer
audience_ids
Any of:
Array<integer>
auto_assign_on_create
Any of:
boolean
chunk_size
Any of:
integer
>= 1
connection_id
required

Which CRM connection to push into.

string
crm_list_id
Any of:
string
file_import_threshold
Any of:
integer
>= 1
large_population_confirmed
Any of:
boolean
lead_id
Any of:
integer
limit
Any of:
integer
>= 1
max_parallel
Any of:
integer
>= 1
salesforce_campaign_id
Any of:
string
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
sync_list_mode
Any of:
string
Allowed values: no_list new_list existing_list
use_file_import
Any of:
boolean

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