Integrations

Push All Leads

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.

post/integrations/crm-sync/leads/push

Request

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

connection_idstring required

Which CRM connection to push into.

limitinteger nullable

Ceiling on records pushed. Omit for the app's default.

chunk_sizeinteger nullable

Records per batch.

max_parallelinteger nullable

Concurrent batches.

use_file_importboolean nullable

Use the provider's bulk file import instead of the API.

file_import_thresholdinteger nullable

Record count above which the file import is used.

crm_list_idstring nullable

Target list in the CRM.

sync_list_mode'no_list' | 'new_list' | 'existing_list' nullable

no_list (the app's default), new_list or existing_list. Sending crm_list_id with no mode implies existing_list.

source_mode'all_qualified' | 'saved_segment' | 'segments_union' | 'all_contacts' nullable

Which population to push. saved_segment REQUIRES audience_id; segments_union REQUIRES audience_ids. Omit for the app's default (all_qualified).

audience_idinteger nullable

graph8 audience for saved_segment.

audience_idsinteger[] nullable

graph8 audiences for segments_union.

salesforce_campaign_idstring nullable

Add every pushed lead to this Salesforce Campaign as a CampaignMember.

lead_idinteger nullable

Push a single graph8 lead row.

status_qualifiedstring nullable

Salesforce Lead.Status API name to set on qualified leads. Read the valid values from /integrations/crm-sync/leads/statuses - Lead.Status is an OPEN picklist, so Salesforce stores whatever is sent and an invented value silently becomes a real status.

status_unqualifiedstring nullable

Salesforce Lead.Status API name for unqualified leads.

large_population_confirmedboolean nullable

Acknowledge that this job covers a population large enough that the app asks first. Leave unset to keep that refusal in place; set true ONLY when you have read the preview's record count and accept it. This is a safety interlock, not a tuning option - the records land in the customer's Salesforce and cannot be un-pushed.

auto_assign_on_createboolean nullable

Run Salesforce's assignment rules on each created lead.

Response

Successful Response

Changes

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