---
title: "Start Lead Preview"
method: POST
path: "/integrations/crm-sync/leads/previews"
tags: ["Integrations"]
---

# Start Lead Preview

`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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- LeadPreviewRequest: Queue a readiness preview of what a lead push WOULD do. Nothing is written to the CRM. This is the call to make before `/integrations/crm-sync/leads/push`, and the only way to learn the record count that `large_population_confirmed` is acknowledging.
  - `connection_id` string, 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_id` integer, nullable
  - `audience_ids` integer[], nullable
  - `status_qualified` string, nullable
  - `status_unqualified` string, nullable
  - `large_population_confirmed` boolean, 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_size` integer, nullable: Rows scanned per page while previewing. Omit for the app's default.

## Response `202`

Successful Response

- ApiResponseSyncJobResponse
  - `data` SyncJobResponse, required: A bulk job, or its status. Open-shaped - the payload carries per-provider progress detail that differs between CRMs and grows with them.
    - `job_id` string, nullable
    - `status` string, nullable
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)