Qodex.ai

Delete coupons

DELETE {{baseUrl}}/v1/applications/:applicationId/campaigns/:campaignId/coupons?value=value&createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&startsAfter=2022-11-08T00:11:22.082Z&startsBefore=2022-11-08T00:11:22.082Z&expiresAfter=2022-11-08T00:11:22.082Z&expiresBefore=2022-11-08T00:11:22.082Z&valid=expired&batchId=value&usable=false&referralId=10&recipientIntegrationId=value&exactMatch=false

Deletes all the coupons matching the specified criteria.

Request Params

KeyDatatypeRequiredDescription
valuestringFilter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
createdBeforestringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
createdAfterstringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
startsAfterstringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
startsBeforestringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
expiresAfterstringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
expiresBeforestringFilter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
validstring- expired: Matches coupons in which the expiration date is set and in the past.
  • validNow: Matches coupons in which start date is null or in the past and expiration date is null or in the future.
  • validFuture: Matches coupons in which start date is set and in the future. | | batchId | string | | Filter results by batches of coupons | | usable | boolean | | - true: only coupons where usageCounter < usageLimit will be returned.
  • false: only coupons where usageCounter >= usageLimit will be returned. | | referralId | number | | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | | recipientIntegrationId | string | | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. | | exactMatch | boolean | | Filter results to an exact case-insensitive matching against the coupon code |