POST /couponCollections

Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
expirationDate String No

Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

name String Yes

Name of the coupons collection

defaultCoupon String Yes

Default coupons collection name

remainingDaysAlert Integer No

Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

remainingCouponsAlert Integer No

Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.