> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/reference/general-exception-lists/models.md).

# Models

## The GeneralExceptionList object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionList":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the general exception list."},"Name":{"type":"string","description":"The display name for the general exception list."},"State":{"type":"string","description":"The current state of the general exception list.","enum":["ACTIVE","CLOSED","DEACTIVATED"]},"CampaignId":{"type":"integer","description":"The program ID the list applies to."},"CreatedDate":{"type":"string","description":"The date and time the list was created, in ISO 8601 format."},"DeactivationDate":{"type":"string","description":"The date and time the list was deactivated, if applicable. Returned as an empty string rather than null when not set."},"ActionTrackers":{"type":"array","description":"The event types this list applies to.","items":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the event type."},"Name":{"type":"string","description":"The display name of the event type."}}}},"NumberOfItems":{"type":"integer","description":"The total number of items in the list. This counter is not incremented when items are added via POST to the Items endpoint, so it can understate the true count after item creation — PATCH and DELETE on the Items endpoint update it correctly."},"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 general exception list in the impact.com API."}}}}}}
```

## The GeneralExceptionListItem object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionListItem":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the general exception list item."},"Value":{"type":"string","description":"The attribute value to match against incoming actions (e.g. a city name, currency code, or custom identifier)."},"Name":{"type":"string","description":"Display name for the item. Returned as an empty string when not set."},"MatchMode":{"type":"string","description":"How the value is matched against incoming actions. Unlike standard Exception Lists, this cannot be controlled when creating or updating items — general exception list items are always an implicit EQ match.","enum":["EQ"]},"ListId":{"type":"integer","description":"The unique identifier of the parent general exception list."},"CreatedDate":{"type":"string","description":"The date and time the item was created, in ISO 8601 format. Observed to sometimes be returned as an empty string on the single-item GET even when populated on the list endpoint."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this item in the impact.com API."}}}}}}
```

## The GeneralExceptionListCreate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionListCreate":{"type":"object","required":["Name","CampaignId","ActionTrackerId"],"properties":{"Name":{"type":"string","description":"The display name for the general exception list. Must be unique within the account — duplicate names are rejected."},"CampaignId":{"type":"integer","description":"The program ID the list applies to."},"ActionTrackerId":{"type":"string","description":"Comma-separated list of event type IDs. Must belong to the specified CampaignId."}}}}}}
```

## The GeneralExceptionListUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionListUpdate":{"type":"object","properties":{"Name":{"type":"string","description":"The display name for the general exception list."},"ActionTrackerId":{"type":"string","description":"Comma-separated list of event type IDs."}}}}}}
```

## The GeneralExceptionListItemCreate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionListItemCreate":{"type":"object","required":["Value"],"properties":{"Value":{"type":"string","description":"The attribute value to match against incoming actions."},"Name":{"type":"string","description":"Display name for the item."},"Upsert":{"type":"boolean","default":false,"description":"If true, updates an existing item with the same 'Value' instead of creating a duplicate."}}}}}}
```

## The GeneralExceptionListItemCreateFile object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"components":{"schemas":{"GeneralExceptionListItemCreateFile":{"type":"object","required":["File"],"properties":{"File":{"type":"string","format":"binary","description":"A .CSV or .XLSX file containing the items to be added, with 'Value' and 'Name' columns. The UI enforces a 5 MB limit before upload; whether the API enforces this independently has not been confirmed (a 5.2 MB file was accepted via the PATCH replace-items operation in testing)."},"Upsert":{"type":"boolean","default":false,"description":"If true, updates existing items where 'Value' matches."}}}}}}
```

## The SuccessUriResponse object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - General Exception Lists","version":"v14"},"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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.