Skip to main content
Countdown TimersVersion: v3New

Update Countdown Timer

PATCH/countdown-timer/timers/{timerId}

Update an existing countdown timer

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:countdown-timer/timer.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

timerIdstringrequired

Countdown Timer ID

Example:60d5f484f0f3c2001f2d5e4a

Body

namestring

Timer name

Example:Updated Timer Name
timerTypestring

Timer type

Available optionsfixeddynamicrecurring
Example:fixed
templateIdstring

Template ID from the list-templates endpoint

Example:minimal
endDatestring

End date (ISO 8601)

Example:2026-04-01T00:00:00.000Z
startDatestring

Start date (ISO 8601)

Example:2026-03-20T00:00:00.000Z
timezonestring

Valid IANA timezone identifier

Example:America/New_York
timerDurationobject

Timer duration

Example
{
  "days": 1,
  "hours": 2,
  "minutes": 0,
  "seconds": 0
}
waitTimeobject

Wait time between recurring loops

Example
{
  "days": 0,
  "hours": 0,
  "minutes": 30,
  "seconds": 0
}
loopCountnumber

Number of recurring loops

Example:3
designMetaobject

Design metadata for timer appearance. Get defaults from the templates endpoint and customize as needed.

Example
{
  "backgroundColor": "#ffffff",
  "textColor": "#111827",
  "separatorColor": "#e5e7eb",
  "labels": {
    "days": "Days",
    "hours": "Hours",
    "minutes": "Minutes",
    "seconds": "Seconds"
  }
}
expiryImageLinkstring

Expiry image link

Example:https://example.com/expiry.png
bgImageLinkstring

Background image link

Example:https://example.com/bg.png
linksobject

Timer redirect links for active, expired, and non-user states

Example
{
  "activeLink": "https://example.com/sale",
  "expiryLink": "https://example.com/expired",
  "notUserLink": "https://example.com/signup"
}
hideTimerForAppleMailboolean

Hide timer for Apple Mail clients

Example:false
hideRecurringTimerFunnelsboolean

Hide recurring timer in funnels preview

Example:false
dynamicTimerParamsobject

Dynamic timer parameters

Example
{
  "endTime": "17:00",
  "trigger": "sent"
}

Response

Timer updated

idstringrequired

Timer ID

Example:60d5f484f0f3c2001f2d5e4a
namestringrequired

Timer name

Example:Flash Sale Timer
templateIdstring

Template ID

Example:minimal
locationIdstringrequired

Location ID

Example:X9COWUStXtcLXTgBdqhm
statusstringrequired

Timer status

Available optionsactivedraftarchived
Example:draft
timerTypestringrequired

Timer type

Available optionsfixeddynamicrecurring
Example:fixed
endDatestring

End date (ISO 8601)

Example:2026-04-01T00:00:00.000Z
startDatestring

Start date (ISO 8601)

Example:2026-03-20T00:00:00.000Z
timezonestring

Timezone

Example:America/New_York
designMetaobject

Design metadata for timer appearance

timerDurationobject

Timer duration

linksobject

Timer links

trackingLinkstring

Tracking link URL

Example:https://t.example.com/abc123
hasLinkboolean

Whether timer has an active link

Example:true
previewUrlstring

Preview image URL

Example:https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gif
thumbnailUrlstring

Thumbnail image URL

Example:https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.png
expiryImageLinkstring

Expiry image link

Example:https://example.com/expiry.png
loopCountnumber

Number of recurring loops

Example:3
waitTimeobject

Wait time between loops

hideTimerForAppleMailboolean

Hide timer for Apple Mail clients

Example:false
hideRecurringTimerFunnelsboolean

Hide recurring timer in funnels

Example:false
dynamicTimerParamsobject

Dynamic timer parameters

createdAtstring

Created timestamp

Example:2026-03-20T12:00:00.000Z
updatedAtstring

Updated timestamp

Example:2026-03-20T12:00:00.000Z