Note! This article is written for the old version of Coupon Carrier. Here's more information about the new version and why you should switch.

Before you start using our API

The Coupon Carrier API is created for developers and those who are comfortable creating integrations using REST APIs. 

Authentication

We use HTTP Basic authentication for our API to authenticate users. Use your API Key (Available under your account settings) as the username and any string as password. Most HTTP client libraries support Basic authentication out of the box.

Examples

Trigger a welcome email containing a unique code to an email address

To add a new email address to your welcome email queue you make a POST request to https://api.couponcarrier.io/v1/welcome-email/queue with a JSON body that contains a parameter named email with the value of your choice.

JSON Body:

{ "email": "john.doe@couponcarrier.io" }

Generate a unique redeem link for a specific email address

To generate a unique link that will assign and show a code to a recipient you make a POST request to https://api.couponcarrier.io/v1/redeem-link/generate with a JSON body that contains a parameter named email and expireLinkAt (optional). The expireLinkAt parameter should be used if you wish to limit the usage of the link to a specific date. After this date this link will not show a code

JSON Body:

{
  "email": "john.doe@couponcarrier.io",
  "expireLinkAt": "2017-01-01"
}


Example response:

{"https://api.couponcarrier.io/redeem-link/68QkvsEw/k4g4V8GO8pSkkyRAgAYoSwRQgQ6xKQhQJ9baGB4ec9Z3TlDVKeOZEzcDge6qxm7McqewyoorJD"}
Did this answer your question?