latestOpenAPI 3.1.02026-08-1039111206.0 KB

c53422ebb833

Promo Codes

List All Promo Codes

Returns a list of your promo codes, with options for filtering by campaign, code, date, and state.

get/Advertisers/{AccountSID}/PromoCodes

Path parameters

AccountSIDstring required

Your unique Account SID.

Query parameters

CampaignIdinteger

Filter by a specific program (campaign) ID.

Codestring

Filter by a specific promo code (must be URL-encoded).

StartDatestring date-time

Filter for codes with a StartDate on or after this value.

EndDatestring date-time

Filter for codes with an EndDate on or before this value.

State'ACTIVE' | 'INACTIVE'

Filter codes by their state.

Response

A paginated list of promo code objects.