Preview Detection Rule
POST /duplicates/settings/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.
Authorizations
Parameters
Header Parameters
Request Body required
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.
object
Object the rule matches on.
Column the rule compares.
How two values are considered equal.
Name for the rule being previewed.
Platform rule template the rule is built from.
Responses
200
Successful Response
object
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”.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error