General Exception Lists

List General Exception Lists

get

Returns a list of your general exception lists, which can be filtered by campaign or state.

Path parameters

AccountSIDstringRequired

Query parameters

CampaignIdintegerOptional

Filter by the program ID the list applies to.

Statestring · enumOptional

Filter lists by their current state.

Possible values:

Responses

200

A list of general exception list objects.

application/json

get/Advertisers/{AccountSID}/GeneralExceptionLists

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A list of general exception list objects.

{
  "GeneralExceptionLists": [
    {
      "Id": 23,
      "Name": "Currencies",
      "State": "ACTIVE",
      "CampaignId": 7474,
      "CreatedDate": "2026-07-22T10:48:31-07:00",
      "DeactivationDate": "",
      "ActionTrackers": [
        {
          "Id": 13416,
          "Name": "Online Sale"
        }
      ],
      "NumberOfItems": 2,
      "ItemsUri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23/Items",
      "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23"
    }
  ]
}

Create a General Exception List

post

Creates a new, empty general exception list for a specific campaign and event type.

Path parameters

AccountSIDstringRequired

Body

NamestringRequired

The display name for the general exception list. Must be unique within the account — duplicate names are rejected.

Example: Currencies

CampaignIdintegerRequired

The program ID the list applies to.

Example: 7474

ActionTrackerIdstringRequired

Comma-separated list of event type IDs. Must belong to the specified CampaignId.

Example: 13416

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

cURL

curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists' \
  --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"
}

Get General Exception List Details

get

Retrieves the details of an existing general exception list by its unique ID.

Path parameters

AccountSIDstringRequired

ListIdintegerRequired

The unique identifier for the general exception list.

Responses

200

A single general exception list object.

application/json

IdintegerOptional

The unique identifier for the general exception list.

Example: 23

NamestringOptional

The display name for the general exception list.

Example: Currencies

Statestring · enumOptional

The current state of the general exception list.

Example: ACTIVEPossible values:

CampaignIdintegerOptional

The program ID the list applies to.

Example: 7474

CreatedDatestringOptional

The date and time the list was created, in ISO 8601 format.

Example: 2026-07-22T10:48:31-07:00

DeactivationDatestringOptional

The date and time the list was deactivated, if applicable. Returned as an empty string rather than null when not set.

NumberOfItemsintegerOptional

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.

Example: 2

ItemsUristring · uri-referenceOptional

The unique reference to the items collection for this list.

Example: /Advertisers/<AccountSID>/GeneralExceptionLists/23/Items

Uristring · uri-referenceOptional

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

Example: /Advertisers/<AccountSID>/GeneralExceptionLists/23

get/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}

cURL

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

200

A single general exception list object.

{
  "Id": 23,
  "Name": "Currencies",
  "State": "ACTIVE",
  "CampaignId": 7474,
  "CreatedDate": "2026-07-22T10:48:31-07:00",
  "DeactivationDate": "",
  "ActionTrackers": [
    {
      "Id": 13416,
      "Name": "Online Sale"
    }
  ],
  "NumberOfItems": 2,
  "ItemsUri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23/Items",
  "Uri": "/Advertisers/<AccountSID>/GeneralExceptionLists/23"
}

Update a General Exception List

put

Updates the specified general exception list's name or associated event type.

Path parameters

AccountSIDstringRequired

ListIdintegerRequired

The unique identifier for the general exception list to update.

Body

NamestringOptional

The display name for the general exception list.

Example: Currencies

ActionTrackerIdstringOptional

Comma-separated list of event type IDs.

Example: 13416

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

put/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}

cURL

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/GeneralExceptionLists/{ListId}' \
  --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"
}