Integrations

Pull All Leads

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.

post/integrations/crm-sync/leads/pull

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/crm-sync/leads/pull
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

connection_idstring required

Which CRM connection to pull from.

list_idinteger nullable

graph8 audience to land the leads in.

enrich_from_graph8boolean nullable

Fill missing fields from the graph8 index as rows arrive. This SPENDS ENRICHMENT CREDIT when on. Omit to take the app's default rather than turning a spend on by accident.

source_mode'all_leads' | 'campaigns' nullable

campaigns restricts the pull to campaign_ids. Omit for the saved setting.

campaign_idsstring[] nullable

Salesforce Campaign ids to pull members of.

include_convertedboolean nullable

Include leads Salesforce has already converted to a Contact.

suppress_from_optoutsboolean nullable

Skip leads that appear on an opt-out list.

limitinteger nullable

Ceiling on records pulled.

chunk_sizeinteger nullable

Records per batch.

max_parallelinteger nullable

Concurrent batches.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.