HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference
Start typing to search…

The exception list object

The exception list object holds information about exception lists you have created, but not about the items within an exception list. You can create, retrieve, update, and delete an exception list, as well as list all exception lists.

Attributes

Id integer

Id of the exception list.

Name string

Name of the exception list.

State enum

What state of use the exception list is in.

View possible enum values
ACTIVEException list is currently live.
CLOSEDException list has been closed out.
DEACTIVATEDException list has been deactivated by an account user.

CampaignId integer

Program Id that this exception list applies to.

Type enum

What the exception list looks to apply to.

View possible enum values
CATEGORYException list is based on the passed Category value on the conversion.
SKUException list is based on the passed SKU value or ProductId on the conversion.

CreatedDate string

Date and time the exception list was created. See ISO-8601.

DeactivationDate string

Date and time the exception list was deactivated. Will be empty if the exception list is not deactivated. See ISO-8601.

ActionTrackers object

Event type(s) (formerly known as action tracker) that the exception list applies to.

View child attributes

Id integer

Event type Id (formerly known as action tracker Id).

Name string

Name of the event type.

NumberOfItems integer

Number of items that the exception list applies to.

ItemsUri string

Exception list's item's direct URI to view what items are included in the exception list.

Uri string

Exception list's direct URI.

{
  "Id": "10000",
  "Name": "WhiteAnvils",
  "State": "ACTIVE",
  "CampaignId": "1000",
  "Type": "CATEGORY",
  "CreatedDate": "2019-09-03T16:15:02-07:00",
  "DeactivationDate": "",
  "ActionTrackers": [
    {
      "Id": "12345",
      "Name": "Online Sale"
    }
  ],
  "NumberOfItems": "2",
  "ItemsUri": "/Advertisers/<AccountSID>/ExceptionLists/10000/Items",
  "Uri": "/Advertisers/<AccountSID>/ExceptionLists/10000"
}