Dry-run a saved or draft rule against the visible records it matches.

Dry-run a rule against the visible records it matches. Give rule_id for a saved rule, or rule (the body rules.create takes, name and basis optional) for a draft, so the rule is checked before it is saved; the agent shorthand and input build the draft the same way. Read-only: a draft is never saved, and a saved rule applies on its own while it is active.

post/v1/rules/preview

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/rules/preview
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Response

Envelope with the matched count, a sample of matching rows with the proposed change, a count per label over every match, and caveats.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.