Integrations

Preview Lead Push

What a lead push would do, computed NOW and returned inline.

Nothing is written to the CRM. The asynchronous twin, POST /integrations/crm-sync/leads/previews, queues the same work and returns a job id instead - use that one for a population large enough that the inline version would time out.

get/integrations/crm-sync/leads/push-preview

Request

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

Query parameters

connection_idstring required

A Salesforce connection.

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

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

audience_idinteger nullable

Required for saved_segment.

audience_idsinteger[] nullable

Required for segments_union.

limitinteger

Ceiling on rows inspected.

status_qualifiedstring nullable
status_unqualifiedstring nullable

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataLeadPreviewResponse required

What a lead push would do. Open-shaped - the readiness detail is per-provider and grows with it.

Changes

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