API of Countdown Timer For Email

Requirements

To use our API, you must have an account in our system, as well as a created and approved application in the account settings. In order to quickly approved your application, you need to write to the support and indicate how you will use the api.

Design for timers

Authentication

All methods in Promofeatures API require authentication, you must set the X-App-Id and X-Secret-key headers. You have to copy the header data from your created application on the settings page.

Timers For Email

  • Version: 1
  • Host: api.promofeatures.com
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json

Timers For Email api allows you to get information about the timer and also create, update, delete it.

All Responses


        {
            "success": true,
            "data": {
                _response_body_
            }
        }

        _or_

        {
            "success": false,
            "message": "_error_message_"
        }
                                

        Unauthorized
                                

        Bad Request
                                

Timer Markup

Basic countdown timer markup that creates the look. Please note that most of the properties are optional, and if the width or height specified in the markup is less than the natural width or height of the timer, then the values ​​will be used in natural size so that the timer is not cut. For more convenient work with the timer markup, in your personal account you can copy any timer markup created through our web interface, the "Copy Markup" button is responsible for this, this button will appear only for an approved developer.

Properties
  • typeTimer integer
    Timer main design type, min - 0, max - 25
  • timerName string
    Timer name
  • endDate string
    Timer end day, format - d/m/Y, example - 10/18/2020
  • endTime string
    Timer end time, format - h:i, example - 12:00
  • lang string
    Label Language, default - EN, format - ISO 639-1
  • timeZoneCode string
    Time zone representation as time offset, format - h:i, example - -07:00
  • timeZone string
    Administrative time zone, example - Olympia, WA, USA
  • timeZoneCode string
    Time zone representation as time offset, format - h:i, example - -07:00
  • frameColor string
    Main frame color, format - hex, example - #ffffff
  • textColor string
    Main text color(numbers, labels and separator), format - hex, example - #ffffff
  • figureColor string
    General color of figures, format - hex, example - #ffffff
  • timeFontSize integer
    Size digits of counter in pixels, min - 0, max - 200
  • timeFontFamily string
    Font family for digits of the counter, default - Arial
  • timeFontStyle integer
    Font style for digits of the counter, default - 0, min - 0, max - 11
  • registerLetter integer
    Font case for digits of the counter, default - 0, min - 0, max - 3
  • spaceType string | void
    A textual representation of a separator, default - :
  • labelDay string | void
    Label name in the "days" segment, for customized auto locating names will not work
  • labelHour string | void
    Label name in the "hours" segment, for customized auto locating names will not work
  • labelMin string | void
    Label name in the "minutes" segment, for customized auto locating names will not work
  • labelSec string | void
    Label name in the "seconds" segment, for customized auto locating names will not work
  • labelMilliseconds string | void
    Label name in the "milliseconds" segment, for customized auto locating names will not work
  • lineDecorColor string | void
    The color of the decorative line of the rectangle describing the counter digit, format - hex, example - #ffffff
  • lineSegmentDecorColor string | void
    The color of the decorative line of the rectangle describing the counter time segment, format - hex, example - #ffffff
  • smallCubeColor string | void
    The color of the rectangles describing the counter digits, format - hex, example - #ffffff
  • smallCubeColor2 string | void
    Color creating a gradient in rectangles describing the counter digits, format - hex, example - #ffffff
  • smallCubeBorderColor string | void
    The color of the rectangle border describing the timer digits, format - hex, example - #ffffff
  • parentCubeBorderColor string | void
    The color of the rectangle border describing the segment of time, format - hex, example - #ffffff
  • parentCubeBorderWidth integer | void
    The width of the rectangle border describing the segment of time, min - 0, max - 100
  • circleFillColor string | void
    Bottom fill color of a circle describing a segment of time, format - hex, example - #ffffff
  • circleFillColor3 string | void
    Top fill color of the circle describing the time segment, format - hex, example - #ffffff
  • circleBorderColorTop string | void
    Top border color of the circle describing the time segment, format - hex, example - #ffffff
  • circleBorderColorBottom string | void
    Bottom border color of the circle describing the time segment, format - hex, example - #ffffff
  • circleBorderWidth integer | void
    Width border of the circle describing the time segment, default - void, min - 0, max - 100
  • smallCircleRadius integer | void
    Radius of small circles describing the time segment, default - void, min - 0, max - 30
  • smallCircleFillColor string | void
    Bottom fill color of small circles describing the time segment, format - hex, example - #ffffff
  • smallCircleFillColor2 string | void
    Top fill color of small circles describing the time segment, format - hex, example - #ffffff
  • countSmallCircles integer | void
    Number of small circles describing the time period, default - void, min - 0, max - 200
  • smallLineFillColor string | void
    Bottom fill color of small lines describing a segment of time, format - hex, example - #ffffff
  • smallLineFillColor2 string | void
    Top fill color of small lines describing a segment of time, format - hex, example - #ffffff
  • countSmallLines integer | void
    Number of small lines(cones) describing the time period, default - void, min - 0, max - 200
  • spaceFontColor2 string | void
    The color of the separator of the counter will create a blinking effect, format - hex, example - #ffffff
  • shadowTimeFontSize integer | void
    The size of the shadow text (numbers, labels) of the counter, default - void, min - 0, max - 100
  • shadowTopOffset integer | void
    Shadow offset to the top of the counter numbers, default - void, min - -20, max - 20
  • shadowLeftOffset integer | void
    The offset of the shadow to the left of the counter numbers, default - void, min - -20, max - 20
  • shadowRadius integer | void
    Blur Shadow, default - void, min - 0, max - 3
  • shadowColor string | void
    The color of the shadow text (numbers, labels) of the counter, format - hex, example - #ffffff
  • shadowTimeFontStyle integer | void
    Font style for shadow digits of the counter, default - 0, min - 0, max - 3
  • preset integer | void
    Timer preset number, default - void, min - 0, max - 18
  • typeTime integer
    Timer type, default - 0, 0 - standart, 1 - transaction, 3 - perpetual
  • transDays integer | void
    The number of days that will count down for Transaction timer, default - void, min - 0, max - 500
  • transHours integer | void
    The number of hours that will count down for Transaction timer, default - void, min - 0, max - 24
  • transMinutes integer | void
    The number of minutes that will count down for Transaction timer, default - void, min - 0, max - 59
  • transSeconds integer | void
    The number of seconds that will count down for Transaction timer, default - void, min - 0, max - 59
  • cycleDays integer | void
    The number of days that will count down for Perpetual timer, default - void, min - 0, max - 500
  • cycleHours integer | void
    The number of hours that will count down for Perpetual timer, default - void, min - 0, max - 24
  • cycleMinutes integer | void
    The number of minutes that will count down for Perpetual timer, default - void, min - 0, max - 59
  • cycleSeconds integer | void
    The number of seconds that will count down for Perpetual timer, default - void, min - 0, max - 59
  • cycleRefreshDays integer | void
    The number of remaining days at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 500
  • cycleRefreshHours integer | void
    The number of remaining hours at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 24
  • cycleRefreshMinutes integer | void
    The number of remaining minutes at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 59
  • cycleRefreshSeconds integer | void
    The number of remaining seconds at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 59
  • widthFrame integer
    Width gif frame, default - 10, min-10, max - 2000
  • heightFrame integer
    Height gif frame, default - 10, min-10, max - 2000
  • imagePath string | void
    The URL of image that will be used as the background of gif animation. Allowed only PNG, JPEG and GIF images.
  • translateX integer
    Timer position relative to the frame. Used if the timer has a background image, default - 0
  • translateY integer
    Timer Y position relative to the frame. Used if the timer has a background image, default - 0
  • timeFontColor string | void
    The color of the digits of the counter, format - hex, example - #ffffff
  • timeFontColor string | void
    The color of the digits of the counter, format - hex, example - #ffffff
  • timeFontTopPadding integer | void
    The upper indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
  • timeFontBottomPadding integer | void
    Bottom indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
  • timeFontRightPadding integer | void
    The right indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
  • timeFontLeftPadding integer | void
    The left indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
  • timeSpace integer | void
    The gap between the digits in the time segment, default - void, min - 0, max - 50
  • daysDigitColor string | void
    Color of digits in segments days, format - hex, example - #ffffff
  • hoursDigitColor string | void
    Color of digits in segments hours, format - hex, example - #ffffff
  • minutesDigitColor string | void
    Color of digits in segments minutes, format - hex, example - #ffffff
  • secondsDigitColor string | void
    Color of digits in segments seconds, format - hex, example - #ffffff
  • millisecondsDigitColor string | void
    Color of digits in segments milliseconds, format - hex, example - #ffffff
  • labelFontSize integer | void
    Size label of counter in pixels, default - void, min - 0, max - 100
  • labelFontFamily string | void
    Font family for label of the counter, default - Arial
  • labelFontColor string | void
    Font family for label of the counter, default - Arial
  • labelFontTopPadding integer | void
    The upper indenting of label by means of which it is possible to correct distances between neighboring objects (figures, digits), default - void, min - 0, max - 50
  • labelFontBottomPadding integer | void
    Bottom indenting of label by means of which it is possible to correct distances between neighboring objects (figures, digits), default - void, min - 0, max - 50
  • labelFontRightPadding integer | void
    The right indenting of label by means of which it is possible to correct distances between neighboring objects (figures, digits), default - void, min - 0, max - 50
  • labelFontLeftPadding integer | void
    The left indenting of label by means of which it is possible to correct distances between neighboring objects (figures, digits), default - void, min - 0, max - 50
  • labelFontStyle integer | void
    Font style for labels of the counter, default - 100, min - 0, max - 11, 100 - auto
  • daysLabelColor string | void
    Color of label in segments days, format - hex, example - #ffffff
  • hoursLabelColor string | void
    Color of label in segments hours, format - hex, example - #ffffff
  • minutesLabelColor string | void
    Color of label in segments minutes, format - hex, example - #ffffff
  • secondsLabelColor string | void
    Color of label in segments seconds, format - hex, example - #ffffff
  • millisecondsLabelColor string | void
    Color of label in segments milliseconds, format - hex, example - #ffffff
  • spaceFontSize integer | void
    Separator size of counter in pixels, default - void, min - 0, max - 100
  • spaceFontFamily string | void
    Font family for separator of the counter, default - Arial
  • spaceFontColor string | void
    Font family for separator of the counter, format - hex, example - #ffffff
  • spaceFontTopPadding integer | void
    The upper indenting of separator by means of which it is possible to correct distances between neighboring objects (figures, digits, labels), default - void, min - 0, max - 50
  • spaceFontBottomPadding integer | void
    Bottom indenting of separator by means of which it is possible to correct distances between neighboring objects (figures, digits, labels), default - void, min - 0, max - 50
  • spaceFontRightPadding integer | void
    The right indenting of separator by means of which it is possible to correct distances between neighboring objects (figures, digits, labels), default - void, min - 0, max - 50
  • spaceFontLeftPadding integer | void
    The left indenting of separator by means of which it is possible to correct distances between neighboring objects (figures, digits, labels), default - void, min - 0, max - 50
  • daysSeparatorColor string | void
    Color of separator in segments days, format - hex, example - #ffffff
  • hoursSeparatorColor string | void
    Color of separator in segments hours, format - hex, example - #ffffff
  • minutesSeparatorColor string | void
    Color of separator in segments minutes, format - hex, example - #ffffff
  • secondsSeparatorColor string | void
    Color of separator in segments seconds, format - hex, example - #ffffff
  • smallCubeBorderWidth integer | void
    The width of the border of the rectangle describing the digit, default - void, min - 0, max - 100
  • cubeTopPadding integer | void
    The upper internal indentation of the rectangle describing the digit, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • cubeBottomPadding integer | void
    The bottom internal indentation of the rectangle describing the digit, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • cubeRightPadding integer | void
    The right internal indentation of the rectangle describing the digit, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • cubeLeftPadding integer | void
    The left internal indentation of the rectangle describing the digit, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • roundRectangle integer | void
    Rounds the right angles of a rectangle describing the digit, default - void, min - 0, max - 100
  • roundBorderRectangle integer | void
    Rounds the right angles of a rectangle border describing the digit, default - void, min - 0, max - 100
  • daysSmallCubeBorderColor string | void
    Border color of a rectangle describing the digits in the days segment, format - hex, example - #ffffff
  • hoursSmallCubeBorderColor string | void
    Border color of a rectangle describing the digits in the hours segment, format - hex, example - #ffffff
  • minutesSmallCubeBorderColor string | void
    Border color of a rectangle describing the digits in the minutes segment, format - hex, example - #ffffff
  • secondsSmallCubeBorderColor string | void
    Border color of a rectangle describing the digits in the seconds segment, format - hex, example - #ffffff
  • millisecondsSmallCubeBorderColor string | void
    Border color of a rectangle describing the digits in the milliseconds segment, format - hex, example - #ffffff
  • daysSmallCubeColor string | void
    Fill color of a rectangle describing the digits in the days segment, format - hex, example - #ffffff
  • hoursSmallCubeColor string | void
    Fill color of a rectangle describing the digits in the hours segment, format - hex, example - #ffffff
  • minutesSmallCubeColor string | void
    Fill color of a rectangle describing the digits in the minutes segment, format - hex, example - #ffffff
  • secondsSmallCubeColor string | void
    Fill color of a rectangle describing the digits in the seconds segment, format - hex, example - #ffffff
  • millisecondsSmallCubeColor string | void
    Fill color of a rectangle describing the digits in the milliseconds segment, format - hex, example - #ffffff
  • parentCubeColor string | void
    The color of the rectangle describing the time segments, format - hex, example - #ffffff
  • roundParentRectangle integer | void
    Rounds the right angles of a rectangle of time segments, default - void, min - 0, max - 100
  • roundParentBorderRectangle integer | void
    Rounds the right angles of a border of time segments, default - void, min - 0, max - 100
  • parentCubeTopPadding integer | void
    The upper internal indentation of the rectangle segment digits, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • parentCubeBottomPadding integer | void
    The bottom internal indentation of the rectangle segment digits, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • parentCubeRightPadding integer | void
    The right internal indentation of the rectangle segment digits, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • parentCubeLeftPadding integer | void
    The left internal indentation of the rectangle segment digits, with which you can adjust the distances between neighboring objects, default - void, min - 0, max - 50
  • daysParentCubeBorderColor string | void
    Border color of a rectangle in the days segment, format - hex, example - #ffffff
  • hoursParentCubeBorderColor string | void
    Border color of a rectangle in the hours segment, format - hex, example - #ffffff
  • minutesParentCubeBorderColor string | void
    Border color of a rectangle in the minutes segment, format - hex, example - #ffffff
  • secondsParentCubeBorderColor string | void
    Border color of a rectangle in the seconds segment, format - hex, example - #ffffff
  • millisecondsParentCubeBorderColor string | void
    Border color of a rectangle in the milliseconds segment, format - hex, example - #ffffff
  • daysParentCubeColor string | void
    Fill color of a rectangle in the days segment, format - hex, example - #ffffff
  • hoursParentCubeColor string | void
    Fill color of a rectangle in the hours segment, format - hex, example - #ffffff
  • minutesParentCubeColor string | void
    Fill color of a rectangle in the minutes segment, format - hex, example - #ffffff
  • secondsParentCubeColor string | void
    Fill color of a rectangle in the seconds segment, format - hex, example - #ffffff
  • millisecondsParentCubeColor string | void
    Fill color of a rectangle in the milliseconds segment, format - hex, example - #ffffff
  • circleRadius integer | void
    Radius of the circle, default - void, min - 0, max - 500
  • smallLinesWidth integer | void
    Width of small lines describing a segment of time, default - void, min - 0, max - 30
  • smallLinesHeight integer | void
    Height of small lines describing a segment of time, default - void, min - 0, max - 30
  • roundBorderCircle boolean
    Rounds a circle border, default - true
  • daysCircleBorderColorTop string | void
    Top border color of the circle describing the days time segment, format - hex, example - #ffffff
  • daysCircleBorderColorBottom string | void
    Bottom border color of the circle describing the days time segment, format - hex, example - #ffffff
  • hoursCircleBorderColorTop string | void
    Top border color of the circle describing the hours time segment, format - hex, example - #ffffff
  • hoursCircleBorderColorBottom string | void
    Bottom border color of the circle describing the hours time segment, format - hex, example - #ffffff
  • minutesCircleBorderColorTop string | void
    Top border color of the circle describing the minutes time segment, format - hex, example - #ffffff
  • minutesCircleBorderColorBottom string | void
    Bottom border color of the circle describing the minutes time segment, format - hex, example - #ffffff
  • secondsCircleBorderColorTop string | void
    Top border color of the circle describing the seconds time segment, format - hex, example - #ffffff
  • secondsCircleBorderColorBottom string | void
    Bottom border color of the circle describing the seconds time segment, format - hex, example - #ffffff
  • millisecondsCircleBorderColorTop string | void
    Top border color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
  • millisecondsCircleBorderColorBottom string | void
    Bottom border color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
  • daysCircleFillColor string | void
    Top fill color of the circle describing the days time segment, format - hex, example - #ffffff
  • daysCircleFillColor3 string | void
    Bottom fill color of the circle describing the days time segment, format - hex, example - #ffffff
  • hoursCircleFillColor string | void
    Top fill color of the circle describing the hours time segment, format - hex, example - #ffffff
  • hoursCircleFillColor3 string | void
    Bottom fill color of the circle describing the hours time segment, format - hex, example - #ffffff
  • minutesCircleFillColor string | void
    Top fill color of the circle describing the minutes time segment, format - hex, example - #ffffff
  • minutesCircleFillColor3 string | void
    Bottom fill color of the circle describing the minutes time segment, format - hex, example - #ffffff
  • secondsCircleFillColor string | void
    Top fill color of the circle describing the seconds time segment, format - hex, example - #ffffff
  • secondsCircleFillColor3 string | void
    Bottom fill color of the circle describing the seconds time segment, format - hex, example - #ffffff
  • millisecondsCircleFillColor string | void
    Top fill color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
  • millisecondsCircleFillColor3 string | void
    Bottom fill color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
  • daysSmallCircleFillColor string | void
    Bottom fill color of small circles describing the days segment, format - hex, example - #ffffff
  • daysSmallCircleFillColor2 string | void
    Top fill color of small circles describing the days segment, format - hex, example - #ffffff
  • hoursSmallCircleFillColor string | void
    Bottom fill color of small circles describing the hours segment, format - hex, example - #ffffff
  • hoursSmallCircleFillColor2 string | void
    Top fill color of small circles describing the hours segment, format - hex, example - #ffffff
  • minutesSmallCircleFillColor string | void
    Bottom fill color of small circles describing the minutes segment, format - hex, example - #ffffff
  • minutesSmallCircleFillColor2 string | void
    Top fill color of small circles describing the minutes segment, format - hex, example - #ffffff
  • secondsSmallCircleFillColor string | void
    Bottom fill color of small circles describing the seconds segment, format - hex, example - #ffffff
  • secondsSmallCircleFillColor2 string | void
    Top fill color of small circles describing the seconds segment, format - hex, example - #ffffff
  • millisecondsSmallCircleFillColor string | void
    Bottom fill color of small circles describing the milliseconds segment, format - hex, example - #ffffff
  • millisecondsSmallCircleFillColor2 string | void
    Top fill color of small circles describing the milliseconds segment, format - hex, example - #ffffff
  • daysSmallLineFillColor string | void
    Bottom fill color of small lines describing a segment of days, format - hex, example - #ffffff
  • daysSmallLineFillColor2 string | void
    Top fill color of small lines describing a segment of days, format - hex, example - #ffffff
  • hoursSmallLineFillColor string | void
    Bottom fill color of small lines describing a segment of hours, format - hex, example - #ffffff
  • hoursSmallLineFillColor2 string | void
    Top fill color of small lines describing a segment of hours, format - hex, example - #ffffff
  • minutesSmallLineFillColor string | void
    Bottom fill color of small lines describing a segment of minutes, format - hex, example - #ffffff
  • minutesSmallLineFillColor2 string | void
    Top fill color of small lines describing a segment of minutes, format - hex, example - #ffffff
  • secondsSmallLineFillColor string | void
    Bottom fill color of small lines describing a segment of seconds, format - hex, example - #ffffff
  • secondsSmallLineFillColor2 string | void
    Top fill color of small lines describing a segment of seconds, format - hex, example - #ffffff
  • millisecondsSmallLineFillColor string | void
    Bottom fill color of small lines describing a segment of milliseconds, format - hex, example - #ffffff
  • millisecondsSmallLineFillColor2 string | void
    Top fill color of small lines describing a segment of milliseconds, format - hex, example - #ffffff
  • transparent boolean
    Includes the transparency of the frame based on the color(control "Background Color"), default - false
  • expiredType integer
    The event when the timer expires. You can change the appearance of the counter when the time is up, hide it or display any message to the user, default - 0, min - 0, max - 3
  • expiredMessage string
    The text to be displayed when the timer expires, default - Offer expired
  • expiredMessageColor string | void
    Expired timer text color, format - hex, example - #ffffff
  • expiredMessageSize integer | void
    Expired timer text size, default - void, min - 0, max - 100
  • disableDays boolean
    Disables segment days, default - false
  • disableHours boolean
    Disables segment hours, default - false
  • disableMinutes boolean
    Disables segment minutes, default - false
  • disableSeconds boolean
    Disables segment seconds, default - false
  • disableMilliseconds boolean
    Disables segment milliseconds, default - true
  • fixedCube boolean
    Make the cube width of all time segments the same (equal to the maximum width of one of the cubes of the segment), it is recommended to enable this option, default - false
  • reverseLabel boolean
    Changes the position of the marks, default - false
  • removeDZero boolean
    Removes the first zero from the segment days of digits, default - false
  • removeHZero boolean
    Removes the first zero from the segment hours of digits, default - false
  • removeMZero boolean
    Removes the first zero from the segment minutes of digits, default - false
  • removeSZero boolean
    Removes the first zero from the segment seconds of digits, default - false

GET /v1/timers?page=1&limit=18&order=0

Get a list of countdown timers

Request

    curl -X GET \
        https://api.promofeatures.com/v1/timers/ \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'
                                    
Request Parameters

3 Query Parameters

  • page integer
    List page number, default = 1
  • limit integer
    Limit of records for one page, default = 18, max = 50
  • order integer
    Sorting records, default = 0, ASC = 0, DESC = 1
Response
  • total integer
    Total number of records
  • pages integer
    number of pages
  • page integer
    Сurrent page
  • order integer
    Sorting records
  • limit integer
    Limit of records for one page
  • list array[object]
    Timer List
    • id integer
      Timer ID
    • name string
      Timer name
    • alias string
      Timer alias
    • markup object
      Timer data
    • update_at integer
      Timer update time
    • create_at integer
      Timer creation time
    • type_time integer
      Timer type 0 - standart, 1 - transaction, 3 - perpetual
    • src string
      Url timer

    {
        "total": 80,
        "pages": 5,
        "page": 1,
        "order": 0,
        "limit": 18,
        "list": [
            ...
            {
                "id": 2,
                "name": "",
                "alias": "aa",
                "markup": {},
                "update_at": 1602951792,
                "create_at": 1602951792,
                "type_time": 1,
                "src": "http://m.promofeatures.com/21233/aa"
            },
            ...
        ]
    }
                                    

POST /v1/timers

Create a countdown timer

Request

    curl -X POST \
        https://api.promofeatures.com/v1/timers/ \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'\
        -d '{"typeTimer": 12, ....}'
                                    
Request Body
Response
  • id integer
    Timer ID
  • name string
    Timer name
  • alias string
    Timer alias
  • markup object
    Timer data
  • update_at integer
    Timer update time
  • create_at integer
    Timer creation time
  • type_time integer
    Timer type 0 - standart, 1 - transaction, 3 - perpetual
  • src string
    Url timer

    {
        "id": 85,
        "name": "My timer",
        "alias": "dd",
        "markup": {
            "typeTimer": 12,
            ...
        },
        "update_at": 1603978149,
        "create_at": 1603978149,
        "type_time": 0,
        "src": "https://m.promofeatures.com/21233/dd"
    }
                                    

PUT /v1/timers/{id}

Update a countdown timer

Request

    curl -X PUT \
        https://api.promofeatures.com/v1/timers/_id_ \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'\
        -d '{"typeTimer": 12, ....}'
                                    
Request Parameters

1 Query Parameter

  • id integer
    Timer id
Request Body
Response
  • id integer
    Timer ID
  • name string
    Timer name
  • alias string
    Timer alias
  • markup object
    Timer data
  • update_at integer
    Timer update time
  • create_at integer
    Timer creation time
  • type_time integer
    Timer type 0 - standart, 1 - transaction, 3 - perpetual
  • src string
    Url timer

    {
        "id": 85,
        "name": "My timer",
        "alias": "dd",
        "markup": {
            "typeTimer": 12,
            ...
        },
        "update_at": 1603978149,
        "create_at": 1603978149,
        "type_time": 0,
        "src": "https://m.promofeatures.com/21233/dd"
    }
                                    

GET /v1/timers/{id}

Get info about countdown timer

Request

    curl -X GET \
        https://api.promofeatures.com/v1/timers/_id_ \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'\
                                    
Request Parameters

1 Query Parameter

  • id integer
    Timer id
Request Body
Response
  • id integer
    Timer ID
  • name string
    Timer name
  • alias string
    Timer alias
  • markup object
    Timer data
  • update_at integer
    Timer update time
  • create_at integer
    Timer creation time
  • type_time integer
    Timer type 0 - standart, 1 - transaction, 3 - perpetual
  • src string
    Url timer

    {
        "id": 85,
        "name": "My timer",
        "alias": "dd",
        "markup": {
            "typeTimer": 12,
            ...
        },
        "update_at": 1603978149,
        "create_at": 1603978149,
        "type_time": 0,
        "src": "https://m.promofeatures.com/21233/dd"
    }
                                    

DELETE /v1/timers/{id}

Delete countdown timer

Request

    curl -X DELETE \
        https://api.promofeatures.com/v1/timers/_id_ \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'\
                                    
Request Parameters

1 Query Parameter

  • id integer
    Timer id

POST /v1/timers/preview

Preview countdown timer for update

Request

    curl -X POST \
        https://api.promofeatures.com/v1/timers/preview \
        -H 'content-type: application/json' \
        -H 'x-app-id: _app_id_' \
        -H 'x-secret-key: _secret_key_'\
        -d '{"typeTimer": 12, ....}'
                                    
Request Body
Response
  • src string
    Url timer

    {
        "src": "http://m.promofeatures.com/uploads/timers/preview/411547c470ac929e010de46cbadf2bcb/411547c470ac929e010de46cbadf2bcb.gif"
    }