Developers can connect our platform with apps or web projects. The Coupontools REST API allows you to query meta-data about your account, coupons, validations, coupon data, scandata and coupon images, distribute mobile coupons by email or SMS and create mobile coupons.

Zapier integration

Zapier Automatically connect Coupontools with your teams' favorite apps like Mailchimp, Constant Contact, Zendesk, SalesForce, and many more - all without writing any code. Zapier connects Coupontools with different apps so you can automate a workflow between them.
For example: You can have the captured email address and name automatically added to a subscribers list in Mailchimp.
Read more about our Zapier integration

Get notifications for events in your account.

Use webhooks to be notified about events that happen in a Coupontools account. Webhooks are a system of automated notifications indicating that an event has occurred in your account. Rather than requiring you to pull information via our API, webhooks push information to your destination when important events occur.

Notifications are delivered via HTTP POST to a destination endpoint on your server and are sent based on the triggers you choose. Each webhook contains a notification kind and the full Coupontools object that the notification is reporting on. This information can be used to update your system or to trigger business processes.

REST API Documentation

The REST APIs provide programmatic access to read and write Coupontools data. Create a new sub account, read coupon captured data, and more. Responses are in JSON format.

This function will return a list of your coupons, with all coupon information
You can use this list to show all coupons on a website or app.
 
Environment
http://api4coupons.com/v2/coupon/list
    POST variables
    • client_id: The client id. Can be found with your API documentation
    • client_secret: Your secret API password. Can be found with your API documentation
    • only_active (optional): When set to true, only coupons marked as 'active' will be returned.
    • pag (optional): API call limited to 100 records per request. In case of more records, use pag 2,3,4 to get remaining records
    Response variables
    • ID: The unique ID of the coupon.
    • code: The unique code of the coupon.
    • name: Name as set in this admin panel
    • title: Title as set in this admin panel
    • subtitle: Sub title as set in this admin panel
    • description: Description as set in this admin panel
    • coupon_tags: Coupon tags
    • coupon_category: Coupon Category
    • expirydate: Expiry date as set in this admin panel (UTC)
    • expirytimezone: Expiry timezone as set in this admin panel
    • logo_url: The web address of the logo
    • poweredby: Powered by name
    • poweredbylink: Powered by website
    • url: Web address of the coupon
    • coupon_image: Web address of the coupon image
    • terms: The terms and conditions from this coupon
    • company_name: Location name
    • company_street: Location street
    • company_zip: Location zip
    • company_city: Location city
    • company_country: Location country
    • company_lat: Location latitude
    • company_long: Location longitude
    This function will return a list of your templates, with all coupon information.
     
    Environment
    http://api4coupons.com/v2/template/list
      POST variables
      • client_id: The client id. Can be found with your API documentation
      • client_secret: Your secret API password. Can be found with your API documentation
      Response variables
      • ID: The unique ID of the coupon.
      • code: The unique code of the coupon.
      • name: Name as set in this admin panel
      • title: Title as set in this admin panel
      • subtitle: Sub title as set in this admin panel
      • description: Description as set in this admin panel
      • coupon_tags: Coupon tags
      • coupon_category: Coupon Category
      • expirydate: Expiry date as set in this admin panel (UTC)
      • expirytimezone: Expiry timezone as set in this admin panel
      • logo_url: The web address of the logo
      • poweredby: Powered by name
      • poweredbylink: Powered by website
      • url: Web address of the coupon
      • coupon_image: Web address of the coupon image
      • terms: The terms and conditions from this coupon
      • company_name: Location name
      • company_street: Location street
      • company_zip: Location zip
      • company_city: Location city
      • company_country: Location country
      • company_lat: Location latitude
      • company_long: Location longitude
      This function will return a list (last 1000 records) of captured claim data from one specific coupon
       
      Environment
      http://api4coupons.com/v2/coupon/claims/[couponcode]
        POST variables
        • client_id: The client id. Can be found with your API documentation
        • client_secret: Your secret API password. Can be found with your API documentation
        Response variables
        • ID: The unique ID of the claim.
        • statcode: The unique statistics code from the claim.
        • valcode: The unique validation code from the claim.
        • claimdate: The claim date in UTC.
        • gender: Gender
        • first_name: First name
        • last_name: Last name
        • email: Email
        • phone: Phone
        • address: Address
        • zip: Zip code
        • city: City
        • birthday: Birthday date
        • coupon_value: Coupon value
        This function will return a list (last 1000 records) of captured validation data from one specific coupon
         
        Environment
        http://api4coupons.com/v2/coupon/validations/[couponcode]
          POST variables
          • client_id: The client id. Can be found with your API documentation
          • client_secret: Your secret API password. Can be found with your API documentation
          Response variables
          • ID: The unique ID of the claim.
          • statcode: The unique statistics code from the claim.
          • valcode: The unique validation code from the claim.
          • claimdate: The claim date in UTC.
          • validatedate: The validation date in UTC.
          • gender: Gender
          • first_name: First name
          • last_name: Last name
          • email: Email
          • phone: Phone
          • address: Address
          • zip: Zip code
          • city: City
          • birthday: Birthday date
          • coupon_value: Coupon value
          This function will return all statistics data from a coupon. This includes: coupon status (claimed, validated, etc.), expiration date, and client's personal data, into a JSON format
           
          Environment
          http://api4coupons.com/v2/getdata/[couponcode]/captured_data_from_coupon_code
            POST variables
            • client_id: The client id. Can be found with your API documentation
            • client_secret: Your secret API password. Can be found with your API documentation
            Response variables
            • response: JSON response with all collected data from a coupon ordered by date ascending.
            This function will return all relevant data from a specific coupon validation code. This includes: coupon status (claimed, validated, etc.), expiration date, and client's personal data. You will have a validation code when you use the "Widget Validation Method". This validation method will give the customer a 6-digit validation code. (eg: "a1b2c3")
             
            Environment
            http://api4coupons.com/v2/coupon/scan_validation_code/[validation_code]
            • [validation_code]: This is the unique code of a specific scan record. It's usually obtained by looking at a claimed coupon, where the validation code is shown along with a QR code and a barcode.
            POST variables
            • client_id: The client id. Can be found with your API documentation
            • client_secret: Your secret API password. Can be found with your API documentation
            Response variables
            • scan_code: A unique code for each coupon user, used for validation
            • scan_datetime: A timestamp for the date and time of the first opening of the coupon
            • claim_datetime: A timestamp for when the user 'claimed' your coupon
            • validate_datetime: A timestamp for when the user 'validated' your coupon
            • customer_id: A unique code to recognize returning customers (cross coupon). Note: only available when a coupon is set up to use customer recognition methods (e.g. Facebook connect or email verification)
            • coupon_value: This is the discount as it was presented to your customer (Scratch prize in case of scratch)
            • max_validity_datetime: A timestamp which indicates the expiration time of the coupon. E.g. a coupon which is only valid 30 minutes after the claim action.
            • redeem_location_id: An ID of the redeem location. Only available after validation with registration of the redeem location.
            • status: Makes an indication (in string format) of the state the coupon is in at the time of the API call. E.g. claimed/not claimed yet/validated
            • coupon_code: The unique code of the coupon to which a scan belongs. Can be used to determine the exact coupon, based on the scan information. This code can also be used to visit the live coupon: http://getcoupon.at/p/[coupon_code]
            This function will set a coupon to claimed status.
             
            Environment
            http://api4coupons.com/v2/coupon/claim_via_scan_validation_code
              POST variables
              • client_id: The client id. Can be found with your API documentation
              • client_secret: Your secret API password. Can be found with your API documentation
              • scan_validation_code: The unique validation scan code
              • coupon_value: The coupon value
              Response variables
              • success: Indicates whether or not the coupon could be validated. The reason why the coupon could not be validated is found in the other variables of this response
              • reason: String with explanation why a coupon was not validated. (Empty in case of succesfull validation)
              • solution: String with 'what-to-do' info to resolve the problem. (Empty in case of succesfull validation)
              • status_code: Error code. 0 in case of succes. Error explanation can be found in other response variables.
              This function will validate a coupon when you use the "Widget Validation Method". This validation method will give you a 6-digit validation code. (eg: "a1b2c3")
               
              Environment
              http://api4coupons.com/v2/coupon/validate_via_scan_validation_code
                POST variables
                • client_id: The client id. Can be found with your API documentation
                • client_secret: Your secret API password. Can be found with your API documentation
                • scan_validation_code: The unique validation scan code
                Response variables
                • success: Indicates whether or not the coupon could be validated. The reason why the coupon could not be validated is found in the other variables of this response
                • reason: String with explanation why a coupon was not validated. (Empty in case of succesfull validation)
                • solution: String with 'what-to-do' info to resolve the problem. (Empty in case of succesfull validation)
                • status_code: Error code. 0 in case of succes. Error explanation can be found in other response variables.
                This function will return unique 'single use' code(s) for a coupon. Single use is used to make coupons accessible for specific users. Only users with a valid 'single use' code can open a coupon.
                 
                Environment
                http://api4coupons.com/v2/coupon/get_single_use_code
                  POST variables
                  • client_id: The client id. Can be found with your API documentation
                  • client_secret: Your secret API password. Can be found with your API documentation
                  • couponcode: The unique couponcode to which you would like to grant access.
                  • count (optional): Define the number of codes you'd like to receive. Limit = 500. Default=1
                  • firstname (optional): First name
                  • lastname (optional): Last name
                  • email (optional): Email
                  • phone (optional): Phone
                  • customid (optional): Custom ID. Max 50 characters (az-AZ-09)
                  Response variables
                  • success: Indicates whether or not the creation of a code succeeded
                  • single_use_code: The generated code in case of success
                  • validation_code: The validation code for validating this coupon
                  • single_use_url: The URL that will grant access to a certain user (includes the access code)
                  • single_use_qr: The URL that will grant access to a certain qr-code image that includes the access code
                  • failure_reason: Indicates the reason why a code creation was not successful (in case of failure of course)
                  This function will remove the single use codes of a specified coupon.

                  Remark: The system will only remove unused codes. This means: codes that are created, but not yet opened or claimed.
                  Warning: The system deletes immediately upon receiving the remove request. NO additional warning is given and removed codes are NOT recoverable.
                   
                  Environment
                  http://api4coupons.com/v2/coupon/remove_single_use_code
                    POST variables
                    • client_id: The client id. Can be found with your API documentation
                    • client_secret: Your secret API password. Can be found with your API documentation
                    • couponcode: The unique coupon code of the coupon which holds the single use codes you would like to remove.
                    • type: Define which category of codes you would like to remove. Options: 'All' = all categories | 'Batch' = bulk generated codes | 'Test' = codes created through the test functionality. [case-insensitive]
                    • code: The exact code you would like to remove. In case you would like to remove ALL codes of a specified type/category, write 'NA'. [case-sensitive]
                    Response variables
                    • success: Indicates whether or not the deletion of code(s) succeeded
                    • fail_reason: In case of failure: explanation
                    • number_of_affected_codes: In case of success: Number of codes which were removed
                    This function will create a new coupon based on a existing coupon
                     
                    Environment
                    http://api4coupons.com/v2/create/coupon
                      POST variables
                      • client_id: The client id. Can be found with your API documentation
                      • client_secret: Your secret API password. Can be found with your API documentation
                      • couponcode: The unique coupon code of the coupon which you want to copy
                      • coupon_name: The new name of the coupon
                      • coupon_title: The title of the coupon
                      • coupon_subtitle: The subtitle of the coupon
                      • coupon_description: The description of the coupon
                      • coupon_tags: Coupon tags
                      • coupon_category: Coupon category
                      • coupon_termsshort: The short terms and conditions of the coupon
                      • coupon_termslong: The full terms and conditions of the coupon
                      • company_name: The business name
                      • company_address: The business address
                      • company_zip: The business zip code
                      • company_city: The business city
                      • company_state: The business state
                      • company_country: The business country
                      • company_phone: The business phone
                      • company_website: The business website
                      • company_email: The business email
                      • company_openinghours: The business opening hours
                      • coupon_expirydate: The expiry date of the coupon (example: 2020-01-24 14:25) in UTC timezone
                      • coupon_startdate: The start date of the coupon (example: 2020-01-24 14:25) in UTC timezone
                      • coupon_value: The value of the discount
                      • validation_title: The value of the title on validation page
                      • validation_description: The value of the description on validation page
                      • barcode_type: The barcode type (UPCA, EAN8, EAN13, CODE39, CODE128, GS1DATABAR, GS1DATABARSTACKED, QR, AZTEC, PDF417)
                      • barcode_value: The barcode value
                      • maximum_coupons: The maximum amounts of coupons, add a zero (0) for unlimited amount of coupons
                      • maximum_coupons_type: Maximum amount type (claim or validate)
                      • validation_password: Password for validation method 'on mobile device' and 'QR code validation'
                      Response variables
                      • No specific response variables will be returned
                      This function will send a coupon to a user
                       
                      Environment
                      http://api4coupons.com/v2/distribute/coupon
                        POST variables
                        • client_id: The client id. Can be found with your API documentation
                        • client_secret: Your secret API password. Can be found with your API documentation
                        • couponcode: The unique coupon code of the coupon which you want to send
                        • sendtype: Send the coupon by 'sms' or 'email'.
                        • receiver: Set here a valid email address or phone number (international format without + or leading zeros.
                        • title (optional): Set here the email subject or SMS body text.
                        • sender (optional): Set here the SMS senderid.
                        Response variables
                        • success: Indicates whether or not the coupon is sent.
                        • reason: String with explanation why the coupon was not sent. (Empty in case of succesfull sending)
                        • status_code: Error code 0 in case of succes. Error code 1 in case of error.
                        • couponcode: String with the used coupon
                        • receiver: String with the used receiver
                        This function will retreive data from all your subaccounts
                         
                        Environment
                        http://api4coupons.com/v2/subaccounts/list
                          POST variables
                          • client_id: The client id. Can be found with your API documentation
                          • client_secret: Your secret API password. Can be found with your API documentation
                          Response variables
                          • ID: The unique ID of the subaccount.
                          • username: The username of the subaccount.
                          • password: The password of the subaccount.
                          • email: Email of the subaccount.
                          • maxcoupons: The amount of maximum coupons the subaccount can publish online.
                          • lastlogin: This is a date that shows when the subaccount was last login.
                          • expiry_date: This is the date that the account expires
                          This function will create an account into your subaccounts
                           
                          Environment
                          http://api4coupons.com/v2/subaccounts/create
                            POST variables
                            • client_id: The client id. Can be found with your API documentation
                            • client_secret: Your secret API password. Can be found with your API documentation
                            • username: The users username.
                            • password: The users password.
                            • email: The users Email.
                            • maxcoupons: The users max coupons.
                            Response variables
                            • ID: The unique ID of the subaccount.
                            • username: The username of the subaccount.
                            • password: The password of the subaccount.
                            • email: Email of the subaccount.
                            • maxcoupons: The amount of maximum coupons the subaccount can publish online.
                            • lastlogin: This is a date that shows when the subaccount was last login.
                            • expiry_date: This is the date that the account expires

                            Register now for a 30-days free trial account

                            Discover our advanced coupon platform today!

                            REGISTER