Skip to content

Pull All Leads

POST
/integrations/crm-sync/leads/pull

Pull Salesforce Leads into graph8.

A body carrying only connection_id runs the org’s SAVED pull.leads settings rather than pulling everything. Any other field overrides those settings for this run only.

enrich_from_graph8 SPENDS ENRICHMENT CREDIT when on. Omit it to take the app’s default rather than turning a spend on by accident.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Pull Salesforce Leads into graph8.

Sending none of the optional fields runs the org’s SAVED pull.leads settings; sending any of them overrides those settings for this one run. That is the app’s behaviour and it is worth knowing, because an empty body here is not “pull everything” - it is “pull what I configured”.

object
campaign_ids
Any of:
Array<string>
chunk_size
Any of:
integer
>= 1
connection_id
required

Which CRM connection to pull from.

string
enrich_from_graph8
Any of:
boolean
include_converted
Any of:
boolean
limit
Any of:
integer
>= 1
list_id
Any of:
integer
max_parallel
Any of:
integer
>= 1
source_mode
Any of:
string
Allowed values: all_leads campaigns
suppress_from_optouts
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
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