The promo code exception list object holds information about promo code exception lists you have created, but not about the items within an exception list. You can create, retrieve, update, and delete a promo code exception list, as well as list all promo code exception lists.
Attributes
Id integer
Id integerId of the promo code exception list.
Name string
Name stringName of the promo code exception list.
State enum
State enumWhat state of use the exception list is in.
| View possible enum values | |
|---|---|
ACTIVE | Promo code exception list is currently live. |
CLOSED | Promo code exception list has been closed out. |
DEACTIVATED | Promo code exception list has been deactivated by an account user. |
CampaignId integer
CampaignId integerProgram Id that this promo code exception list applies to.
CreatedDate string
CreatedDate stringDate and time the promo code exception list was created. See ISO-8601.
DeactivationDate string
DeactivationDate stringDate and time the promo code exception list was deactivated. Will be empty if the exception list is not deactivated. See ISO-8601.
ActionTrackers object
ActionTrackers objectEvent type(s) (formerly known as action tracker) that the exception list applies to.
View child attributes
Id integer
Id integerEvent type Id (formerly known as action tracker Id).
Name string
Name stringName of the event type.
NumberOfItems integer
NumberOfItems integerNumber of items that the promo code exception list applies to.
ItemsUri string
ItemsUri stringPromo code exception list's item's direct URI to view what items are included in the exception list.
Uri string
Uri stringPromo code exception list's direct URI.
{
"Id": "10000",
"Name": "WhiteAnvils",
"State": "ACTIVE",
"CampaignId": "1000",
"CreatedDate": "2019-09-03T16:15:02-07:00",
"DeactivationDate": "",
"ActionTrackers": [
{
"Id": "12345",
"Name": "Online Sale"
}
],
"NumberOfItems": "2",
"ItemsUri": "/Advertisers/<AccountSID>/PromoCodeExceptionLists/10000/Items",
"Uri": "/Advertisers/<AccountSID>/PromoCodeExceptionLists/10000"
}