younifyd
Menu

Delete Coupons

Delete coupons

DELETE/v1/applications/{applicationId}/campaigns/{campaignId}/coupons

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Delete Coupons action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{deleteCoupons.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger (int64)required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Query parameters

valuestring

Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.

createdBeforestring (date-time)

Filter 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.

createdAfterstring (date-time)

Filter 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.

startsAfterstring (date-time)

Filter 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.

startsBeforestring (date-time)

Filter 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.

expiresAfterstring (date-time)

Filter 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.

expiresBeforestring (date-time)

Filter 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.

One ofexpiredvalidNowvalidFuture

batchIdstring

Filter results by batches of coupons

usablestring

- `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.

One oftruefalse

referralIdinteger (int64)

Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.

recipientIntegrationIdstring

Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field.

exactMatchboolean

Filter results to an exact case-insensitive matching against the coupon code

Default false

Response

Returns 204 with a any. Read it in later steps with {{deleteCoupons.response.data.<field>}}.

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Delete Coupons — Talon.One — Documentation