Integrations

Start Lead Preview

Queue a readiness preview and return a job id immediately.

Nothing is written to the CRM. Poll GET /integrations/crm-sync/jobs/{job_id} for the result, which carries the record count large_population_confirmed exists to acknowledge.

post/integrations/crm-sync/leads/previews

Request

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

connection_idstring required

Which CRM connection to preview against.

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

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

audience_idinteger nullable
audience_idsinteger[] nullable
status_qualifiedstring nullable
status_unqualifiedstring nullable
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.

page_sizeinteger nullable

Rows scanned per page while previewing. Omit for the app's default.

Response

Successful Response

Changes

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