Tool to create a discount code for a campaign. Use when you need to provide promotional pricing or discounts for campaign items.
codeRequiredstringThe discount code string that users will enter. Must be unique within the campaign and no more than 255 characters.
typeRequiredstringType of discount: 'percentage' for a percentage-based discount (e.g., 10% off), or 'fixed' for a fixed amount discount (e.g., $10 off).
usesintegerMaximum number of times the discount code can be used. If not provided, there is no usage limit.
itemsarrayList of item IDs that the discount code applies to. If not provided, the code applies to all items in the campaign.
activeRequiredbooleanWhether the discount code is active and can be used immediately.
amountRequirednumberDiscount amount. For 'percentage' type, this is the percentage (e.g., 10 for 10% off). For 'fixed' type, this is the amount in cents (e.g., 1000 for $10.00 off).
campaignRequiredintegerThe campaign ID to create the discount code for.
starts_atstringUTC datetime string when the discount code becomes active (ISO-8601 format). If not provided, the code is active immediately.
expires_atstringUTC datetime string when the discount code expires (ISO-8601 format). If not provided, the code will not expire.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.