For the complete documentation index, see llms.txt. This page is also available as Markdown.

General Exception List Items

List Items in a General Exception List

get

Returns a list of all items within a specific general exception list.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired

The unique identifier for the general exception list.

Query parameters
ValuestringOptional

Filter items by their 'Value'.

Responses
200

A list of general exception list item objects.

application/json
get/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items
cURL
curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

A list of general exception list item objects.

{
  "GeneralExceptionListItems": [
    {
      "Id": 644814,
      "Value": "AUD",
      "Name": "AUD",
      "MatchMode": "EQ",
      "ListId": 23,
      "CreatedDate": "2026-07-23T12:44:43-07:00",
      "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23/Items/644814"
    }
  ]
}

Create Items in a General Exception List

post

Creates one or more new items for a general exception list, either via form parameters for a single item or by uploading a file for multiple items.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired

The unique identifier for the general exception list.

Body
ValuestringRequired

The attribute value to match against incoming actions.

Example: AUD
NamestringOptional

Display name for the item.

Example: AUD
UpsertbooleanOptional

If true, updates an existing item with the same 'Value' instead of creating a duplicate.

Default: falseExample: true
Responses
200

The request was successful.

application/json
StatusstringOptional

Indicates whether the operation was successful.

Example: OK
Uristring · uri-referenceOptional

The unique reference to the affected resource.

Example: /Advertisers/<AccountSID>/GeneralExceptionLists/23
post/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items
cURL
curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'
200

The request was successful.

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23"
}

Delete All Items from a General Exception List

delete

Permanently deletes all items in a general exception list. This cannot be undone.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired

The unique identifier for the general exception list.

Responses
200

All items were deleted successfully.

application/json
StatusstringOptional

Indicates that the resource was deleted.

Example: DELETED
delete/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items
cURL
curl -L \
  --request DELETE \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

All items were deleted successfully.

{
  "Status": "DELETED"
}

Replace All Items in a General Exception List

patch

Replaces all items within an existing general exception list by uploading a new .CSV or .XLSX file. The impact.com UI blocks files of 5 MB or larger before upload, but this was not reproduced on the API directly — a 5.2 MB (210,000-row) file was accepted and fully processed in testing.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired

The unique identifier for the general exception list.

Body
Filestring · binaryRequired

A .CSV or .XLSX file containing the new items. The UI enforces a 5 MB limit before upload; the API itself accepted a 5.2 MB file in testing, so this does not appear to be enforced server-side.

Responses
200

The request was successful.

application/json
StatusstringOptional

Indicates whether the operation was successful.

Example: OK
Uristring · uri-referenceOptional

The unique reference to the affected resource.

Example: /Advertisers/<AccountSID>/GeneralExceptionLists/23
patch/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items
cURL
curl -L \
  --request PATCH \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*' \
  --form 'File=@/path/to/items.csv'
200

The request was successful.

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23"
}

Get General Exception List Item Details

get

Retrieves the details of a single item from a general exception list.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired
ItemIdintegerRequired

The unique identifier for the general exception list item.

Responses
200

A single general exception list item object.

application/json
IdintegerOptional

The unique identifier for the general exception list item.

Example: 644814
ValuestringOptional

The attribute value to match against incoming actions (e.g. a city name, currency code, or custom identifier).

Example: AUD
NamestringOptional

Display name for the item. Returned as an empty string when not set.

Example: AUD
MatchModestring · enumOptional

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.

Example: EQPossible values:
ListIdintegerOptional

The unique identifier of the parent general exception list.

Example: 23
CreatedDatestringOptional

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.

Example: 2026-07-23T12:44:43-07:00
Uristring · uri-referenceOptional

The unique reference to this item in the impact.com API.

Example: /Advertisers/<AccountSID>/GeneralExceptionLists/23/Items/644814
get/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items/{ItemId}
cURL
curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items/{ItemId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

A single general exception list item object.

{
  "Id": 644814,
  "Value": "AUD",
  "Name": "AUD",
  "MatchMode": "EQ",
  "ListId": 23,
  "CreatedDate": "2026-07-23T12:44:43-07:00",
  "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23/Items/644814"
}

Delete a General Exception List Item

delete

Permanently deletes a single item from a general exception list. This cannot be undone.

Path parameters
AccountSIDstringRequired
ListIdintegerRequired
ItemIdintegerRequired

The unique identifier for the general exception list item.

Responses
200

The item was deleted successfully.

application/json
StatusstringOptional

Indicates that the resource was deleted.

Example: DELETED
delete/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items/{ItemId}
cURL
curl -L \
  --request DELETE \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}/Items/{ItemId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

The item was deleted successfully.

{
  "Status": "DELETED"
}

Last updated