Attributes

Id integer

The unique identifier assigned to the promo code.

Code string

The string of numbers and letters that make up the promo code.

Uri string (URI)

URI for this promo code resource.

State enum

The status of the promo code. Allowed: ACTIVE, FUTUREDATE, EXPIRED.

Program object

Details about the associated program (Id, Name, Uri).

Advertiser object

Details about the associated brand (Id, Name, Uri, LogoUri).

Deal object

Details about the associated deal (Id, Name, Uri).

MatchMode enum

The matching type of each promo code. Allowed values: LI (Exact match), RE (Regex match).

CreditRule enum

The credit policy assigned to the promo code. Allowed values: ALWAYS, INVOLVED, WINNER.

CreatedDate string

The ISO8601 date/time promo code was created.

StartDate string

The ISO8601 date/time promo code becomes active. If unspecified, promo code starts at creation time.

EndDate string

The ISO 8601 date/time promo code becomes inactive. If unspecified, the promo code remains active indefinitely.

{
	"Id": 123456,
	"Code": "SUMMER21",
	"Uri": "/Mediapartners/<AccountSID>/PromoCodes/123456",
	"State": "ACTIVE",
	"Program": {
		"Id": 7890,
		"Name": "Summer Sale Program",
		"Uri": "/Mediapartners/<AccountSID>/Programs/7890"
	},
	"Advertiser": {
		"Id": 4567,
		"Name": "Acme Corp",
		"Uri": "/Mediapartners/<AccountSID>/Advertisers/4567",
		"LogoUri": "https://example.com/logos/acme.png"
	},
	"Deal": {
		"Id": 2345,
		"Name": "Summer Deal",
		"Uri": "/Mediapartners/<AccountSID>/Deals/2345"
	},
	"MatchMode": "LI",
	"CreditRule": "ALWAYS",
	"CreatedDate": "2025-07-01T12:00:00Z",
	"StartDate": "2025-07-15T00:00:00Z",
	"EndDate": "2025-08-15T23:59:59Z"
}