> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itspropel.com/llms.txt.
> For full documentation content, see https://docs.itspropel.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server.

# Preview Matches (Dry-Run)

POST https://opportunities/automation/rules/preview-matches
Content-Type: multipart/form-data

Dry-run: returns the count + sample of opportunities that would match the given condition set without persisting anything.

**Throttle:** throttle:automation-preview (60/min/user)

Reference: https://docs.itspropel.com/propel-biz/34-leads/automation/opportunities-rules-executions/preview-matches-dry-run

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: PropelBiz
  version: 1.0.0
paths:
  /opportunities/automation/rules/preview-matches:
    post:
      operationId: preview-matches-dry-run
      summary: Preview Matches (Dry-Run)
      description: >-
        Dry-run: returns the count + sample of opportunities that would match
        the given condition set without persisting anything.


        **Throttle:** throttle:automation-preview (60/min/user)
      tags:
        - >-
          subpackage_34Leads.subpackage_34Leads/automation.subpackage_34Leads/automation/opportunitiesRulesExecutions
      parameters:
        - name: '{{tenant_key_name}}'
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/34 Leads_Automation_Opportunities — Rules
                  + Executions_Preview Matches (Dry-Run)_Response_200
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                entity_type:
                  type: string
                  description: 'Required: "opportunity" for this endpoint'
                trigger_type:
                  type: string
                  description: 'Required: Valid TriggerType enum case'
                conditions[0][operator]:
                  type: string
                  description: 'Required: operator name'
                conditions[0][field_path]:
                  type: string
                  description: >-
                    Required: dotted accessor (e.g.
                    opportunity.opportunity_stage_id)
              required:
                - entity_type
                - trigger_type
                - conditions[0][operator]
                - conditions[0][field_path]
servers:
  - url: https:/
components:
  schemas:
    34 Leads_Automation_Opportunities — Rules + Executions_Preview Matches (Dry-Run)_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: >-
        34 Leads_Automation_Opportunities — Rules + Executions_Preview Matches
        (Dry-Run)_Response_200

```

## SDK Code Examples

```python
import requests

url = "https://https/opportunities/automation/rules/preview-matches"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity_type\"\r\n\r\nopportunity\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_type\"\r\n\r\nstage_changed\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operator]\"\r\n\r\nequals\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][field_path]\"\r\n\r\nopportunity.opportunity_stage_id\r\n-----011000010111000001101001--\r\n"
headers = {
    "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://https/opportunities/automation/rules/preview-matches';
const form = new FormData();
form.append('entity_type', 'opportunity');
form.append('trigger_type', 'stage_changed');
form.append('conditions[0][operator]', 'equals');
form.append('conditions[0][field_path]', 'opportunity.opportunity_stage_id');

const options = {
  method: 'POST',
  headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'}
};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://https/opportunities/automation/rules/preview-matches"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity_type\"\r\n\r\nopportunity\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_type\"\r\n\r\nstage_changed\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operator]\"\r\n\r\nequals\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][field_path]\"\r\n\r\nopportunity.opportunity_stage_id\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://https/opportunities/automation/rules/preview-matches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity_type\"\r\n\r\nopportunity\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_type\"\r\n\r\nstage_changed\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operator]\"\r\n\r\nequals\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][field_path]\"\r\n\r\nopportunity.opportunity_stage_id\r\n-----011000010111000001101001--\r\n"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://https/opportunities/automation/rules/preview-matches")
  .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity_type\"\r\n\r\nopportunity\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_type\"\r\n\r\nstage_changed\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operator]\"\r\n\r\nequals\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][field_path]\"\r\n\r\nopportunity.opportunity_stage_id\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://https/opportunities/automation/rules/preview-matches', [
  'multipart' => [
    [
        'name' => 'entity_type',
        'contents' => 'opportunity'
    ],
    [
        'name' => 'trigger_type',
        'contents' => 'stage_changed'
    ],
    [
        'name' => 'conditions[0][operator]',
        'contents' => 'equals'
    ],
    [
        'name' => 'conditions[0][field_path]',
        'contents' => 'opportunity.opportunity_stage_id'
    ]
  ]
  'headers' => [
    '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://https/opportunities/automation/rules/preview-matches");
var request = new RestRequest(Method.POST);
request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity_type\"\r\n\r\nopportunity\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_type\"\r\n\r\nstage_changed\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operator]\"\r\n\r\nequals\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][field_path]\"\r\n\r\nopportunity.opportunity_stage_id\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"]
let parameters = [
  [
    "name": "entity_type",
    "value": "opportunity"
  ],
  [
    "name": "trigger_type",
    "value": "stage_changed"
  ],
  [
    "name": "conditions[0][operator]",
    "value": "equals"
  ],
  [
    "name": "conditions[0][field_path]",
    "value": "opportunity.opportunity_stage_id"
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://https/opportunities/automation/rules/preview-matches")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```