Create Countdown Timer
Create a countdown timer for the access token's location
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
countdown-timer/ timer. writeOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3v3Body
Timer name
Flash Sale TimerTimer type
fixeddynamicrecurringfixedTemplate ID from the list-templates endpoint
minimalEnd date in ISO 8601 format. Required for fixed timers.
2026-04-01T00:00:00.000ZValid IANA timezone identifier
America/New_YorkTimer duration. Required for dynamic and recurring timers.
{
"days": 1,
"hours": 2,
"minutes": 0,
"seconds": 0
}
Wait time between recurring loops
{
"days": 0,
"hours": 0,
"minutes": 30,
"seconds": 0
}
Design metadata for timer appearance. Get defaults from the templates endpoint and customize as needed.
{
"backgroundColor": "#ffffff",
"textColor": "#111827",
"separatorColor": "#e5e7eb",
"labels": {
"days": "Days",
"hours": "Hours",
"minutes": "Minutes",
"seconds": "Seconds"
}
}
Hide timer for Apple Mail clients
falsefalseDynamic timer parameters. Required for dynamic timers.
{
"endTime": "17:00",
"trigger": "sent"
}
Timer redirect links for active, expired, and non-user states
{
"activeLink": "https://example.com/sale",
"expiryLink": "https://example.com/expired",
"notUserLink": "https://example.com/signup"
}
Image to show when timer expires
https://example.com/expiry.pngBackground image for timer
https://example.com/bg.pngResponse
Timer created successfully
Timer ID
60d5f484f0f3c2001f2d5e4aTimer name
Flash Sale TimerTemplate ID
minimalLocation ID
X9COWUStXtcLXTgBdqhmTimer status
activedraftarchiveddraftTimer type
fixeddynamicrecurringfixedEnd date (ISO 8601)
2026-04-01T00:00:00.000ZStart date (ISO 8601)
2026-03-20T00:00:00.000ZTimezone
America/New_YorkDesign metadata for timer appearance
Timer duration
Timer links
Tracking link URL
https://t.example.com/abc123Whether timer has an active link
truePreview image URL
https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gifThumbnail image URL
https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.pngExpiry image link
https://example.com/expiry.pngNumber of recurring loops
3Wait time between loops
Hide timer for Apple Mail clients
falseHide recurring timer in funnels
falseDynamic timer parameters
Created timestamp
2026-03-20T12:00:00.000ZUpdated timestamp
2026-03-20T12:00:00.000Z