Exception List Items

List All Items in an Exception List

get

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

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Query parameters

ValuestringOptional

Filter items by their 'Value' (the SKU or Category).

Responses

200

A list of exception list item objects.

application/json

get/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of exception list item objects.

{
  "ExceptionListItems": [
    {
      "Id": 1001,
      "Value": "CA",
      "Name": "California",
      "MatchMode": "EQ",
      "ListId": 99999,
      "CreatedDate": "2026-01-15T10:00:00-08:00",
      "Uri": "../folder"
    }
  ]
}

Create Item(s) for an Exception List

post

Creates one or more new items for an exception list, either via form parameters or by file upload.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Body

application/x-www-form-urlencodedmultipart/form-data

ValuestringRequired

The CATEGORY or SKU value.

Example: CA

NamestringOptional

Display name for the item.

Example: California

UpsertbooleanOptional

If true, updates an existing item with the same 'Value'.

Default: falseExample: true

Responses

200

The item(s) were created or queued successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected resource.

post/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items

HTTPcURLJavaScriptPython

POST /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 48

"Value='CA'&Name='California'&Upsert=true"

application/x-www-form-urlencodedmultipart/form-data

200

The item(s) were created or queued successfully.

{
  "Status": "OK",
  "Uri": "../folder"
}

Delete All Items in an Exception List

delete

Permanently deletes all items from a specified exception list. This cannot be undone.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Responses

200

The resource was successfully deleted.

application/json

StatusstringOptional

Indicates that the resource was deleted.

Example: DELETED

delete/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items

HTTPcURLJavaScriptPython

DELETE /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

The resource was successfully deleted.

{
  "Status": "DELETED"
}

Replace All Items in an Exception List

patch

Replaces all items within an existing exception list by uploading a file.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Body

multipart/form-data

Filestring · binaryRequired

.CSV or .XLSX file with the complete new list of items.

Responses

200

The items were replaced successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected resource.

patch/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items

HTTPcURLJavaScriptPython

PATCH /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "File": "binary"
}

200

The items were replaced successfully.

{
  "Status": "OK",
  "Uri": "../folder"
}

Retrieve an Exception List Item

get

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

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

ItemIdintegerRequired

The unique identifier for the exception list item.

Responses

200

A single exception list item object.

application/json

IdintegerOptional

The unique identifier for the exception list item.

Example: 1001

ValuestringOptional

The CATEGORY or SKU value.

Example: CA

NamestringOptional

Display name for the item.

Example: California

MatchModestring · enumOptional

How the value is matched against incoming actions.

Possible values:

ListIdintegerOptional

The unique identifier of the parent exception list.

Example: 99999

CreatedDatestring · date-timeOptional

The date and time the item was created.

Example: 2026-01-15T10:00:00-08:00

Uristring · uri-referenceOptional

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

get/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single exception list item object.

{
  "Id": 1001,
  "Value": "CA",
  "Name": "California",
  "MatchMode": "EQ",
  "ListId": 99999,
  "CreatedDate": "2026-01-15T10:00:00-08:00",
  "Uri": "../folder"
}

Delete an Exception List Item

delete

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

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique Account SID.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

ItemIdintegerRequired

The unique identifier for the exception list item.

Responses

200

The resource was successfully deleted.

application/json

StatusstringOptional

Indicates that the resource was deleted.

Example: DELETED

delete/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}

HTTPcURLJavaScriptPython

DELETE /Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

The resource was successfully deleted.

{
  "Status": "DELETED"
}