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.
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.
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
typeTimerinteger
Timer main design type, min - 0, max - 25
timerNamestring
Timer name
endDatestring
Timer end day, format - d/m/Y, example - 10/18/2020
endTimestring
Timer end time, format - h:i, example - 12:00
langstring
Label Language, default - EN, format - ISO 639-1
timeZoneCodestring
Time zone representation as time offset, format - h:i, example - -07:00
timeZonestring
Administrative time zone, example - Olympia, WA, USA
frameColorstring
Main frame color, format - hex, example - #ffffff
textColorstring
Main text color(numbers, labels and separator), format - hex, example - #ffffff
figureColorstring
General color of figures, format - hex, example - #ffffff
timeFontSizeinteger
Size digits of counter in pixels, min - 0, max - 200
timeFontFamilystring
Font family for digits of the counter, default - Arial
timeFontStyleinteger
Font style for digits of the counter, default - 0, min - 0, max - 11
registerLetterinteger
Font case for digits of the counter, default - 0, min - 0, max - 3
spaceTypestring | void
A textual representation of a separator, default - :
labelDaystring | void
Label name in the "days" segment, for customized auto locating names will not work
labelHourstring | void
Label name in the "hours" segment, for customized auto locating names will not work
labelMinstring | void
Label name in the "minutes" segment, for customized auto locating names will not work
labelSecstring | void
Label name in the "seconds" segment, for customized auto locating names will not work
labelMillisecondsstring | void
Label name in the "milliseconds" segment, for customized auto locating names will not work
lineDecorColorstring | void
The color of the decorative line of the rectangle describing the counter digit, format - hex, example - #ffffff
lineSegmentDecorColorstring | void
The color of the decorative line of the rectangle describing the counter time segment, format - hex, example - #ffffff
smallCubeColorstring | void
The color of the rectangles describing the counter digits, format - hex, example - #ffffff
smallCubeColor2string | void
Color creating a gradient in rectangles describing the counter digits, format - hex, example - #ffffff
smallCubeBorderColorstring | void
The color of the rectangle border describing the timer digits, format - hex, example - #ffffff
parentCubeBorderColorstring | void
The color of the rectangle border describing the segment of time, format - hex, example - #ffffff
parentCubeBorderWidthinteger | void
The width of the rectangle border describing the segment of time, min - 0, max - 100
circleFillColorstring | void
Bottom fill color of a circle describing a segment of time, format - hex, example - #ffffff
circleFillColor3string | void
Top fill color of the circle describing the time segment, format - hex, example - #ffffff
circleBorderColorTopstring | void
Top border color of the circle describing the time segment, format - hex, example - #ffffff
circleBorderColorBottomstring | void
Bottom border color of the circle describing the time segment, format - hex, example - #ffffff
circleBorderWidthinteger | void
Width border of the circle describing the time segment, default - void, min - 0, max - 100
smallCircleRadiusinteger | void
Radius of small circles describing the time segment, default - void, min - 0, max - 30
smallCircleFillColorstring | void
Bottom fill color of small circles describing the time segment, format - hex, example - #ffffff
smallCircleFillColor2string | void
Top fill color of small circles describing the time segment, format - hex, example - #ffffff
countSmallCirclesinteger | void
Number of small circles describing the time period, default - void, min - 0, max - 200
smallLineFillColorstring | void
Bottom fill color of small lines describing a segment of time, format - hex, example - #ffffff
smallLineFillColor2string | void
Top fill color of small lines describing a segment of time, format - hex, example - #ffffff
countSmallLinesinteger | void
Number of small lines(cones) describing the time period, default - void, min - 0, max - 200
spaceFontColor2string | void
The color of the separator of the counter will create a blinking effect, format - hex, example - #ffffff
shadowTimeFontSizeinteger | void
The size of the shadow text (numbers, labels) of the counter, default - void, min - 0, max - 100
shadowTopOffsetinteger | void
Shadow offset to the top of the counter numbers, default - void, min - -20, max - 20
shadowLeftOffsetinteger | void
The offset of the shadow to the left of the counter numbers, default - void, min - -20, max - 20
shadowRadiusinteger | void
Blur Shadow, default - void, min - 0, max - 3
shadowColorstring | void
The color of the shadow text (numbers, labels) of the counter, format - hex, example - #ffffff
shadowTimeFontStyleinteger | void
Font style for shadow digits of the counter, default - 0, min - 0, max - 3
presetinteger | void
Timer preset number, default - void, min - 0, max - 18
transDaysinteger | void
The number of days that will count down for Transaction timer, default - void, min - 0, max - 500
transHoursinteger | void
The number of hours that will count down for Transaction timer, default - void, min - 0, max - 24
transMinutesinteger | void
The number of minutes that will count down for Transaction timer, default - void, min - 0, max - 59
transSecondsinteger | void
The number of seconds that will count down for Transaction timer, default - void, min - 0, max - 59
cycleDaysinteger | void
The number of days that will count down for Perpetual timer, default - void, min - 0, max - 500
cycleHoursinteger | void
The number of hours that will count down for Perpetual timer, default - void, min - 0, max - 24
cycleMinutesinteger | void
The number of minutes that will count down for Perpetual timer, default - void, min - 0, max - 59
cycleSecondsinteger | void
The number of seconds that will count down for Perpetual timer, default - void, min - 0, max - 59
cycleRefreshDaysinteger | void
The number of remaining days at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 500
cycleRefreshHoursinteger | void
The number of remaining hours at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 24
cycleRefreshMinutesinteger | void
The number of remaining minutes at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 59
cycleRefreshSecondsinteger | void
The number of remaining seconds at which the counter will start the countdown again for Perpetual timer, default - void, min - 0, max - 59
imagePathstring | void
The URL of image that will be used as the background of gif animation. Allowed only PNG, JPEG and GIF images.
translateXinteger
Timer position relative to the frame. Used if the timer has a background image, default - 0
translateYinteger
Timer Y position relative to the frame. Used if the timer has a background image, default - 0
timeFontColorstring | void
The color of the digits of the counter, format - hex, example - #ffffff
timeFontColorstring | void
The color of the digits of the counter, format - hex, example - #ffffff
timeFontTopPaddinginteger | void
The upper indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
timeFontBottomPaddinginteger | void
Bottom indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
timeFontRightPaddinginteger | void
The right indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
timeFontLeftPaddinginteger | void
The left indent of numbers, with which you can adjust the distance between adjacent objects (numbers, marks), default - void, min - 0, max - 50
timeSpaceinteger | void
The gap between the digits in the time segment, default - void, min - 0, max - 50
daysDigitColorstring | void
Color of digits in segments days, format - hex, example - #ffffff
hoursDigitColorstring | void
Color of digits in segments hours, format - hex, example - #ffffff
minutesDigitColorstring | void
Color of digits in segments minutes, format - hex, example - #ffffff
secondsDigitColorstring | void
Color of digits in segments seconds, format - hex, example - #ffffff
millisecondsDigitColorstring | void
Color of digits in segments milliseconds, format - hex, example - #ffffff
labelFontSizeinteger | void
Size label of counter in pixels, default - void, min - 0, max - 100
labelFontFamilystring | void
Font family for label of the counter, default - Arial
labelFontColorstring | void
Font family for label of the counter, default - Arial
labelFontTopPaddinginteger | 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
labelFontBottomPaddinginteger | 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
labelFontRightPaddinginteger | 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
labelFontLeftPaddinginteger | 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
labelFontStyleinteger | void
Font style for labels of the counter, default - 100, min - 0, max - 11, 100 - auto
daysLabelColorstring | void
Color of label in segments days, format - hex, example - #ffffff
hoursLabelColorstring | void
Color of label in segments hours, format - hex, example - #ffffff
minutesLabelColorstring | void
Color of label in segments minutes, format - hex, example - #ffffff
secondsLabelColorstring | void
Color of label in segments seconds, format - hex, example - #ffffff
millisecondsLabelColorstring | void
Color of label in segments milliseconds, format - hex, example - #ffffff
spaceFontSizeinteger | void
Separator size of counter in pixels, default - void, min - 0, max - 100
spaceFontFamilystring | void
Font family for separator of the counter, default - Arial
spaceFontColorstring | void
Font family for separator of the counter, format - hex, example - #ffffff
spaceFontTopPaddinginteger | 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
spaceFontBottomPaddinginteger | 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
spaceFontRightPaddinginteger | 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
spaceFontLeftPaddinginteger | 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
daysSeparatorColorstring | void
Color of separator in segments days, format - hex, example - #ffffff
hoursSeparatorColorstring | void
Color of separator in segments hours, format - hex, example - #ffffff
minutesSeparatorColorstring | void
Color of separator in segments minutes, format - hex, example - #ffffff
secondsSeparatorColorstring | void
Color of separator in segments seconds, format - hex, example - #ffffff
smallCubeBorderWidthinteger | void
The width of the border of the rectangle describing the digit, default - void, min - 0, max - 100
cubeTopPaddinginteger | 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
cubeBottomPaddinginteger | 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
cubeRightPaddinginteger | 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
cubeLeftPaddinginteger | 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
roundRectangleinteger | void
Rounds the right angles of a rectangle describing the digit, default - void, min - 0, max - 100
roundBorderRectangleinteger | void
Rounds the right angles of a rectangle border describing the digit, default - void, min - 0, max - 100
daysSmallCubeBorderColorstring | void
Border color of a rectangle describing the digits in the days segment, format - hex, example - #ffffff
hoursSmallCubeBorderColorstring | void
Border color of a rectangle describing the digits in the hours segment, format - hex, example - #ffffff
minutesSmallCubeBorderColorstring | void
Border color of a rectangle describing the digits in the minutes segment, format - hex, example - #ffffff
secondsSmallCubeBorderColorstring | void
Border color of a rectangle describing the digits in the seconds segment, format - hex, example - #ffffff
millisecondsSmallCubeBorderColorstring | void
Border color of a rectangle describing the digits in the milliseconds segment, format - hex, example - #ffffff
daysSmallCubeColorstring | void
Fill color of a rectangle describing the digits in the days segment, format - hex, example - #ffffff
hoursSmallCubeColorstring | void
Fill color of a rectangle describing the digits in the hours segment, format - hex, example - #ffffff
minutesSmallCubeColorstring | void
Fill color of a rectangle describing the digits in the minutes segment, format - hex, example - #ffffff
secondsSmallCubeColorstring | void
Fill color of a rectangle describing the digits in the seconds segment, format - hex, example - #ffffff
millisecondsSmallCubeColorstring | void
Fill color of a rectangle describing the digits in the milliseconds segment, format - hex, example - #ffffff
parentCubeColorstring | void
The color of the rectangle describing the time segments, format - hex, example - #ffffff
roundParentRectangleinteger | void
Rounds the right angles of a rectangle of time segments, default - void, min - 0, max - 100
roundParentBorderRectangleinteger | void
Rounds the right angles of a border of time segments, default - void, min - 0, max - 100
parentCubeTopPaddinginteger | 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
parentCubeBottomPaddinginteger | 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
parentCubeRightPaddinginteger | 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
parentCubeLeftPaddinginteger | 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
daysParentCubeBorderColorstring | void
Border color of a rectangle in the days segment, format - hex, example - #ffffff
hoursParentCubeBorderColorstring | void
Border color of a rectangle in the hours segment, format - hex, example - #ffffff
minutesParentCubeBorderColorstring | void
Border color of a rectangle in the minutes segment, format - hex, example - #ffffff
secondsParentCubeBorderColorstring | void
Border color of a rectangle in the seconds segment, format - hex, example - #ffffff
millisecondsParentCubeBorderColorstring | void
Border color of a rectangle in the milliseconds segment, format - hex, example - #ffffff
daysParentCubeColorstring | void
Fill color of a rectangle in the days segment, format - hex, example - #ffffff
hoursParentCubeColorstring | void
Fill color of a rectangle in the hours segment, format - hex, example - #ffffff
minutesParentCubeColorstring | void
Fill color of a rectangle in the minutes segment, format - hex, example - #ffffff
secondsParentCubeColorstring | void
Fill color of a rectangle in the seconds segment, format - hex, example - #ffffff
millisecondsParentCubeColorstring | void
Fill color of a rectangle in the milliseconds segment, format - hex, example - #ffffff
circleRadiusinteger | void
Radius of the circle, default - void, min - 0, max - 500
smallLinesWidthinteger | void
Width of small lines describing a segment of time, default - void, min - 0, max - 30
smallLinesHeightinteger | void
Height of small lines describing a segment of time, default - void, min - 0, max - 30
roundBorderCircleboolean
Rounds a circle border, default - true
daysCircleBorderColorTopstring | void
Top border color of the circle describing the days time segment, format - hex, example - #ffffff
daysCircleBorderColorBottomstring | void
Bottom border color of the circle describing the days time segment, format - hex, example - #ffffff
hoursCircleBorderColorTopstring | void
Top border color of the circle describing the hours time segment, format - hex, example - #ffffff
hoursCircleBorderColorBottomstring | void
Bottom border color of the circle describing the hours time segment, format - hex, example - #ffffff
minutesCircleBorderColorTopstring | void
Top border color of the circle describing the minutes time segment, format - hex, example - #ffffff
minutesCircleBorderColorBottomstring | void
Bottom border color of the circle describing the minutes time segment, format - hex, example - #ffffff
secondsCircleBorderColorTopstring | void
Top border color of the circle describing the seconds time segment, format - hex, example - #ffffff
secondsCircleBorderColorBottomstring | void
Bottom border color of the circle describing the seconds time segment, format - hex, example - #ffffff
millisecondsCircleBorderColorTopstring | void
Top border color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
millisecondsCircleBorderColorBottomstring | void
Bottom border color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
daysCircleFillColorstring | void
Top fill color of the circle describing the days time segment, format - hex, example - #ffffff
daysCircleFillColor3string | void
Bottom fill color of the circle describing the days time segment, format - hex, example - #ffffff
hoursCircleFillColorstring | void
Top fill color of the circle describing the hours time segment, format - hex, example - #ffffff
hoursCircleFillColor3string | void
Bottom fill color of the circle describing the hours time segment, format - hex, example - #ffffff
minutesCircleFillColorstring | void
Top fill color of the circle describing the minutes time segment, format - hex, example - #ffffff
minutesCircleFillColor3string | void
Bottom fill color of the circle describing the minutes time segment, format - hex, example - #ffffff
secondsCircleFillColorstring | void
Top fill color of the circle describing the seconds time segment, format - hex, example - #ffffff
secondsCircleFillColor3string | void
Bottom fill color of the circle describing the seconds time segment, format - hex, example - #ffffff
millisecondsCircleFillColorstring | void
Top fill color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
millisecondsCircleFillColor3string | void
Bottom fill color of the circle describing the milliseconds time segment, format - hex, example - #ffffff
daysSmallCircleFillColorstring | void
Bottom fill color of small circles describing the days segment, format - hex, example - #ffffff
daysSmallCircleFillColor2string | void
Top fill color of small circles describing the days segment, format - hex, example - #ffffff
hoursSmallCircleFillColorstring | void
Bottom fill color of small circles describing the hours segment, format - hex, example - #ffffff
hoursSmallCircleFillColor2string | void
Top fill color of small circles describing the hours segment, format - hex, example - #ffffff
minutesSmallCircleFillColorstring | void
Bottom fill color of small circles describing the minutes segment, format - hex, example - #ffffff
minutesSmallCircleFillColor2string | void
Top fill color of small circles describing the minutes segment, format - hex, example - #ffffff
secondsSmallCircleFillColorstring | void
Bottom fill color of small circles describing the seconds segment, format - hex, example - #ffffff
secondsSmallCircleFillColor2string | void
Top fill color of small circles describing the seconds segment, format - hex, example - #ffffff
millisecondsSmallCircleFillColorstring | void
Bottom fill color of small circles describing the milliseconds segment, format - hex, example - #ffffff
millisecondsSmallCircleFillColor2string | void
Top fill color of small circles describing the milliseconds segment, format - hex, example - #ffffff
daysSmallLineFillColorstring | void
Bottom fill color of small lines describing a segment of days, format - hex, example - #ffffff
daysSmallLineFillColor2string | void
Top fill color of small lines describing a segment of days, format - hex, example - #ffffff
hoursSmallLineFillColorstring | void
Bottom fill color of small lines describing a segment of hours, format - hex, example - #ffffff
hoursSmallLineFillColor2string | void
Top fill color of small lines describing a segment of hours, format - hex, example - #ffffff
minutesSmallLineFillColorstring | void
Bottom fill color of small lines describing a segment of minutes, format - hex, example - #ffffff
minutesSmallLineFillColor2string | void
Top fill color of small lines describing a segment of minutes, format - hex, example - #ffffff
secondsSmallLineFillColorstring | void
Bottom fill color of small lines describing a segment of seconds, format - hex, example - #ffffff
secondsSmallLineFillColor2string | void
Top fill color of small lines describing a segment of seconds, format - hex, example - #ffffff
millisecondsSmallLineFillColorstring | void
Bottom fill color of small lines describing a segment of milliseconds, format - hex, example - #ffffff
millisecondsSmallLineFillColor2string | void
Top fill color of small lines describing a segment of milliseconds, format - hex, example - #ffffff
transparentboolean
Includes the transparency of the frame based on the color(control "Background Color"), default - false
expiredTypeinteger
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
expiredMessagestring
The text to be displayed when the timer expires, default - Offer expired
expiredMessageColorstring | void
Expired timer text color, format - hex, example - #ffffff
expiredMessageSizeinteger | void
Expired timer text size, default - void, min - 0, max - 100
fixedCubeboolean
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
reverseLabelboolean
Changes the position of the marks, default - false
removeDZeroboolean
Removes the first zero from the segment days of digits, default - false
removeHZeroboolean
Removes the first zero from the segment hours of digits, default - false
removeMZeroboolean
Removes the first zero from the segment minutes of digits, default - false
removeSZeroboolean
Removes the first zero from the segment seconds of digits, default - false