# Models

## The ExceptionList object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v12"},"components":{"schemas":{"ExceptionList":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the exception list."},"Name":{"type":"string","description":"The display name for the exception list."},"State":{"$ref":"#/components/schemas/ExceptionListState","description":"The current state of the exception list."},"CampaignId":{"type":"integer","description":"The program ID the list applies to."},"Type":{"$ref":"#/components/schemas/ExceptionListType","description":"Whether this list applies to CATEGORY or SKU."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the list was created."},"DeactivationDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the list was deactivated, if applicable."},"ActionTrackers":{"type":"array","description":"The action trackers (event types) this list applies to.","items":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the action tracker."},"Name":{"type":"string","description":"The display name of the action tracker."}}}},"NumberOfItems":{"type":"integer","description":"The total number of items in the list."},"ItemsUri":{"type":"string","format":"uri-reference","description":"The unique reference to the items collection for this list."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this exception list in the impact.com API."}}},"ExceptionListState":{"type":"string","enum":["ACTIVE","CLOSED","DEACTIVATED"]},"ExceptionListType":{"type":"string","enum":["CATEGORY","SKU"]}}}}
```

## The ExceptionListItem object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v12"},"components":{"schemas":{"ExceptionListItem":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the exception list item."},"Value":{"type":"string","description":"The CATEGORY or SKU value."},"Name":{"type":"string","description":"Display name for the item."},"MatchMode":{"type":"string","description":"How the value is matched against incoming actions.","enum":["EQ","REGEX"]},"ListId":{"type":"integer","description":"The unique identifier of the parent exception list."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the item was created."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this item in the impact.com API."}}}}}}
```

## The ExceptionListState object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v12"},"components":{"schemas":{"ExceptionListState":{"type":"string","enum":["ACTIVE","CLOSED","DEACTIVATED"]}}}}
```

## The ExceptionListType object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v12"},"components":{"schemas":{"ExceptionListType":{"type":"string","enum":["CATEGORY","SKU"]}}}}
```

## The SuccessUriResponse object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v12"},"components":{"schemas":{"SuccessUriResponse":{"type":"object","properties":{"Status":{"type":"string","description":"Indicates whether the operation was successful."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to the affected resource."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v12/reference/exception-lists/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
