---
title: "Preview Detection Rule"
method: POST
path: "/duplicates/settings/preview-detection-rule"
tags: ["Contacts"]
---

# Preview Detection Rule

`POST /duplicates/settings/preview-detection-rule`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/duplicates/settings/preview-detection-rule`
- Auth: HTTP bearer

Dry-run a duplicate-detection rule. Writes nothing.

Returns the pair count the rule would match plus a small sample, which is
the only way to size a rule before auto-merge acts on it. A POST because
the rule is a body; tiered a read so a read-only key can check a rule
before someone saves it.

## Headers

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

## Request body

- PreviewDetectionRuleRequest: Dry-run a duplicate-detection rule. Writes nothing. Returns how many pairs the rule would match plus a small sample, which is the only way to size a rule before auto-merge starts acting on it.
  - `rule_name` string, required: Name for the rule being previewed.
  - `template` string, required: Platform rule template the rule is built from.
  - `entity_type` 'contact' | 'company' | 'deal', required: Object the rule matches on.
  - `field` string, required: Column the rule compares.
  - `match_mode` 'exact' | 'normalized' | 'fuzzy_levenshtein' | 'domain_match' | 'phone_e164' | 'linkedin_handle', required: How two values are considered equal.
  - `score` integer, nullable: Override the platform default score for this rule.
  - `confidence_bucket` 'high' | 'medium' | 'low', nullable: Override the default confidence bucket.

## Response `200`

Successful Response

- ApiResponseCrmRecordPayload
  - `data` CrmRecordPayload, required: An open envelope for one record, one dashboard or one job receipt. Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say "nothing to report" rather than "we did not tell you".
  - `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)