# Models

## The PromoCode object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Promo Codes","version":"v13"},"components":{"schemas":{"PromoCode":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the promo code."},"Code":{"type":"string","description":"The promo code value."},"Type":{"type":"string","description":"LI for Exact match, RE for Regex.","enum":["LI","RE"]},"CreditPolicy":{"type":"string","description":"How credit is awarded for actions involving this code.","enum":["ALWAYS","INVOLVED","WINNER"]},"CampaignId":{"type":"integer","description":"The unique identifier of the program this promo code applies to."},"CampaignName":{"type":"string","description":"The display name of the program."},"AssignedPartnerId":{"type":"integer","description":"The unique identifier of the partner this promo code is assigned to."},"AssignedPartnerName":{"type":"string","description":"The display name of the assigned partner."},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the promo code was created."},"StartDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the promo code becomes active."},"EndDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the promo code expires."},"State":{"type":"string","description":"The current state of the promo code.","enum":["ACTIVE","INACTIVE"]},"DealId":{"type":"integer","nullable":true,"description":"The unique identifier of the Deal this promo code is linked to, if any."},"DealName":{"type":"string","nullable":true,"description":"The display name of the linked Deal."},"DealState":{"type":"string","nullable":true,"description":"The state of the linked Deal."},"DealType":{"type":"string","nullable":true,"description":"The type of the linked Deal."},"DealScope":{"type":"string","nullable":true,"description":"The scope of the linked Deal."},"DealStartDate":{"type":"string","format":"date-time","nullable":true,"description":"The start date of the linked Deal."},"DealEndDate":{"type":"string","format":"date-time","nullable":true,"description":"The end date of the linked Deal."},"DiscountType":{"type":"string","nullable":true,"description":"How the discount is calculated."},"DiscountAmount":{"type":"number","format":"decimal","nullable":true,"description":"The flat discount amount, when DiscountType is FIXED."},"DiscountCurrency":{"type":"string","nullable":true,"description":"Three-letter ISO 4217 currency code for the discount."},"DiscountPercent":{"type":"number","format":"float","nullable":true,"description":"The discount percentage, when DiscountType is PERCENT."},"MinimumPurchaseAmount":{"type":"number","format":"decimal","nullable":true,"description":"The minimum order amount required for the deal to apply."},"MaximumSavingsAmount":{"type":"number","format":"decimal","nullable":true,"description":"The maximum total savings the deal can apply to a single order."},"PurchaseLimitQuantity":{"type":"integer","description":"Maximum number of times the deal can be applied per order."},"BogoBuyQuantity":{"type":"integer","description":"Quantity the customer must buy in a BOGO deal."},"BogoBuyName":{"type":"string","nullable":true,"description":"Name of the item the customer must buy in a BOGO deal."},"BogoGetQuantity":{"type":"integer","description":"Quantity the customer receives in a BOGO deal."},"BogoGetName":{"type":"string","nullable":true,"description":"Name of the item the customer receives in a BOGO deal."},"BogoGetDiscountType":{"type":"string","nullable":true,"description":"How the discount on the \"get\" item is calculated in a BOGO deal."},"SynchAdsPromoCodes":{"type":"boolean","description":"Whether to synchronize promo codes with ads."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this promo code in the impact.com API."}}}}}}
```

## The PromoCodeCreate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Promo Codes","version":"v13"},"components":{"schemas":{"PromoCodeCreate":{"type":"object","required":["AssignedPartnerId","CampaignId","CreditPolicy","Code","Type"],"properties":{"AssignedPartnerId":{"type":"integer","description":"The partner account ID this promo code is assigned to."},"CampaignId":{"type":"integer","description":"The program ID this promo code applies to."},"CreditPolicy":{"type":"string","description":"How credit is awarded for actions involving this code.","enum":["ALWAYS","INVOLVED","WINNER"]},"Code":{"type":"string","description":"The promo code value."},"Type":{"type":"string","description":"LI for Exact match, RE for Regex.","enum":["LI","RE"]},"StartDate":{"type":"string","format":"date-time","description":"The date and time the promo code becomes active."},"EndDate":{"type":"string","format":"date-time","description":"The date and time the promo code expires."},"DealId":{"type":"integer","description":"The unique identifier of a Deal to link this promo code to."},"DealName":{"type":"string","description":"The display name of the linked Deal."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v13/reference/promo-codes/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.