Contacts

Preview Detection Rule

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

rule_namestring required

Name for the rule being previewed.

templatestring required

Platform rule template the rule is built from.

entity_type'contact' | 'company' | 'deal' required

Object the rule matches on.

fieldstring required

Column the rule compares.

match_mode'exact' | 'normalized' | 'fuzzy_levenshtein' | 'domain_match' | 'phone_e164' | 'linkedin_handle' required

How two values are considered equal.

scoreinteger nullable

Override the platform default score for this rule.

confidence_bucket'high' | 'medium' | 'low' nullable

Override the default confidence bucket.

Response

Successful Response

dataCrmRecordPayload 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".

Changes

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