Exception Lists

List All Exception Lists

get

Returns a list of your exception lists, with options for filtering.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Query parameters

CampaignIdintegerOptional

Filter by a specific program (campaign) ID.

Statestring · enumOptional

Filter lists by their current state.

Possible values:

Typestring · enumOptional

Filter lists by their type.

Possible values:

Responses

200

A list of exception list objects.

application/json

get/Advertisers/{AccountSID}/ExceptionLists

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

200

A list of exception list objects.

{
  "ExceptionLists": [
    {
      "Id": 99999,
      "Name": "USA-State-CA-Exclusions",
      "State": "ACTIVE",
      "CampaignId": 1000,
      "Type": "CATEGORY",
      "CreatedDate": "2026-01-15T10:00:00-08:00",
      "DeactivationDate": "2026-12-31T23:59:59-08:00",
      "ActionTrackers": [
        {
          "Id": 18500,
          "Name": "Online Sale"
        }
      ],
      "NumberOfItems": 50,
      "ItemsUri": "/Advertisers/<AccountSID>/ExceptionLists/99999/Items",
      "Uri": "/Advertisers/<AccountSID>/ExceptionLists/99999"
    }
  ]
}

Create an Exception List

post

Creates a new exception list.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Body

ActionTrackerIdstringRequired

Comma-separated list of event type IDs.

Example: 18500

CampaignIdintegerRequired

The program ID the list applies to.

Example: 1000

NamestringRequired

The name of the exception list.

Example: USA-State-CA-Exclusions

Typestring · enumRequired

Whether this list applies to CATEGORY or SKU.

Possible values:

Responses

200

The exception list was created 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

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

"ActionTrackerId='18500'&CampaignId=1000&Name='USA-State-CA-Exclusions'&Type='CATEGORY'"

200

The exception list was created successfully.

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

Retrieve an Exception List

get

Retrieves the details of a single, existing exception list by its ID.

Authorizations

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

A single exception list object.

application/json

IdintegerOptional

The unique identifier for the exception list.

Example: 99999

NamestringOptional

The display name for the exception list.

Example: USA-State-CA-Exclusions

Statestring · enumOptional

The current state of the exception list.

Possible values:

CampaignIdintegerOptional

The program ID the list applies to.

Example: 1000

Typestring · enumOptional

Whether this list applies to CATEGORY or SKU.

Possible values:

CreatedDatestring · date-timeOptional

The date and time the list was created.

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

DeactivationDatestring · date-time · nullableOptional

The date and time the list was deactivated, if applicable.

Example: 2026-12-31T23:59:59-08:00

NumberOfItemsintegerOptional

The total number of items in the list.

Example: 50

ItemsUristring · uri-referenceOptional

The unique reference to the items collection for this list.

Example: /Advertisers/<AccountSID>/ExceptionLists/99999/Items

Uristring · uri-referenceOptional

The unique reference to this exception list in the impact.com API.

Example: /Advertisers/<AccountSID>/ExceptionLists/99999

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

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

200

A single exception list object.

{
  "Id": 99999,
  "Name": "USA-State-CA-Exclusions",
  "State": "ACTIVE",
  "CampaignId": 1000,
  "Type": "CATEGORY",
  "CreatedDate": "2026-01-15T10:00:00-08:00",
  "DeactivationDate": "2026-12-31T23:59:59-08:00",
  "ActionTrackers": [
    {
      "Id": 18500,
      "Name": "Online Sale"
    }
  ],
  "NumberOfItems": 50,
  "ItemsUri": "/Advertisers/<AccountSID>/ExceptionLists/99999/Items",
  "Uri": "/Advertisers/<AccountSID>/ExceptionLists/99999"
}

Update an Exception List

put

Updates the specified exception list.

Authorizations

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 to update.

Body

ActionTrackerIdstringOptional

Comma-separated list of event type IDs.

Example: 18500

NamestringOptional

The display name for the exception list.

Example: USA-State-CA-Exclusions

Typestring · enumOptional

Whether this list applies to CATEGORY or SKU.

Possible values:

Responses

200

The exception list was updated successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected resource.

put/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}

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

"ActionTrackerId='18500'&Name='USA-State-CA-Exclusions'&Type='CATEGORY'"

200

The exception list was updated successfully.

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