> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Simulate skip check

> Dry-run of the skip rules against the supplied ticket or recent real events; nothing is touched.

### Path parameters

<ParamField path="brand_id" type="string (uuid)" required />

### Request body

`object`

<ParamField body="config" type="object">
  Candidate config; defaults to the saved binding config
</ParamField>

<ParamField body="ticket" type="object">
  A single ticket to evaluate; defaults to recent real events
</ParamField>

<ParamField body="recent_limit" type="integer">
  1–25, default 10
</ParamField>

### Response

`object`

<ResponseField name="brand_id" type="string (uuid)" required />

<ResponseField name="rule_count" type="integer" required />

<ResponseField name="evaluated" type="integer" required />

<ResponseField name="would_skip" type="integer" required />

<ResponseField name="would_process" type="integer" required />

<ResponseField name="results" type="object[]" required>
  <Expandable title="results">
    <ResponseField name="ticket" type="string" required>
      'supplied' or the recent-event label
    </ResponseField>

    <ResponseField name="should_skip" type="boolean" />

    <ResponseField name="reason" type="string" />

    <ResponseField name="error" type="string">
      Present instead of `should_skip` when the rule evaluation itself failed
    </ResponseField>
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                                                                          |
| ----- | ------------------------------------------------------------------------------------------------ |
| `200` | Dry-run of the skip rules against the supplied ticket or recent real events; nothing is touched. |
| `400` | Validation error                                                                                 |
| `401` | Unauthorized                                                                                     |
| `404` | Not found                                                                                        |
| `429` | Rate limited                                                                                     |
| `500` | Internal error                                                                                   |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/config/simulate-skip' \
    --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{
    "config": {},
    "ticket": {},
    "recent_limit": 1
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "rule_count": 1,
    "evaluated": 1,
    "would_skip": 1,
    "would_process": 1,
    "results": [
      {
        "ticket": "string",
        "should_skip": true,
        "reason": "Two-person tent, green — replacement for damaged pole set.",
        "error": "string"
      }
    ]
  }
  ```
</ResponseExample>