v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Promo Code

createCampaignPromoCode

Create Promo Code for the specified Campaign

post/campaigns/{campaign}/promo-codes

Path parameters

campaigninteger required

Example:227362

Primary identifier of specified Campaign

Request body

adjustment_amountnumber double

Value to configure price adjustment when applied against an item. Can reflect either a percentage or flat amount based on associated adjustment_type

adjustment_type'percentage' | 'amount'

Specification of how adjustment_amount is applied

codestring

Value of the Promo Code to entered on checkout

ends_atstring date-time nullable

Date/time when the Promo Code can no longer be applied to purchases

is_activeboolean

Indicates whether Promo Code is active or not regardless of availability or date range

is_generalboolean

Indicates whether Promo Code has a general designation, meaning it applies to all TicketTypes for its Campaign

quantityinteger nullable

Total number of items against which the Promo Code can be applied (null implies unlimited applications)

starts_atstring date-time nullable

Date/time when record can start being applied to purchase

Example request

{
  "adjustment_amount": 10,
  "adjustment_type": "percentage",
  "code": "TENPERCENTOFF",
  "ends_at": "2021-04-23T08:23:21Z",
  "is_active": true,
  "quantity": 100,
  "starts_at": "2021-04-23T08:23:21Z"
}

Response

Success

adjustment_amountnumber double

Value to configure price adjustment when applied against an Item. Can reflect either a percentage or flat amount based on associated adjustment_type

adjustment_type'percentage' | 'amount'

Specification of how adjustment_amount is applied

applications_countinteger

Count of the number of times the promo code has been applied to Items still in a Cart or successfully transacted against

codestring

Value of the Promo Code to entered on checkout

ends_atstring date-time nullable

Date/time when the Promo Code can no longer be applied to purchases

idinteger

Primary identifier of record

is_activeboolean

Indicates whether Promo Code is active or not regardless of availability or date range

is_generalboolean

Indicates whether Promo Code has a general designation, meaning it applies to all TicketTypes for its Campaign

quantityinteger nullable

Total number of Items against which the Promo Code can be applied (null implies unlimited applications)

starts_atstring date-time nullable

Date/time when record can start being applied to purchase

updated_atstring date-time

Date/time of last record update

campaign_idinteger

Example response

{
  "adjustment_amount": 10,
  "adjustment_type": "percentage",
  "applications_count": 22,
  "code": "TENPERCENTOFF",
  "ends_at": "2021-04-23T08:23:21Z",
  "id": 8273,
  "is_active": true,
  "quantity": 100,
  "starts_at": "2021-04-23T08:23:21Z",
  "updated_at": "2021-04-23T10:25:03Z",
  "campaign_id": 227362
}