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

Exception List Items

List all items for an exception list

get
Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

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
cURL
200

A list of exception list item objects.

Create an item for an exception list

post

Create an item manually or via CSV/XLSX file upload.

Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Body
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'.

Example: true
Responses
200

The item(s) were created successfully.

application/json
StatusstringOptional

Indicates whether the operation was successful.

Uristring · uri-referenceOptional

The unique reference to the affected resource.

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

The item(s) were created successfully.

Delete all items in an exception list

delete
Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Responses
200

All items were deleted successfully.

application/json
StatusstringOptional

Indicates that the items were deleted.

Example: DELETED
delete/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items
cURL
200

All items were deleted successfully.

Replace all items in an exception list

patch

Replaces items by uploading a .CSV or .XLSX file.

Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

Body
Filestring · binaryRequired

A .CSV or .XLSX file containing the new items.

Responses
200

The items were replaced successfully.

application/json
StatusstringOptional

Indicates whether the operation was successful.

Uristring · uri-referenceOptional

The unique reference to the affected resource.

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

The items were replaced successfully.

Retrieve an exception list item

get
Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

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}
cURL
200

A single exception list item object.

Delete an item for an exception list

delete
Authorizations
AuthorizationstringRequired
Path parameters
AccountSIDstringRequired

The unique identifier for the account.

ExceptionListIdintegerRequired

The unique identifier for the exception list.

ItemIdintegerRequired

The unique identifier for the exception list item.

Responses
200

The item was deleted successfully.

application/json
StatusstringOptional

Indicates that the item was deleted.

Example: DELETED
delete/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}/Items/{ItemId}
cURL
200

The item was deleted successfully.

Last updated