Resource Guide

Timers

Timers are live saved canvas timer images. Use this resource when you already have a saved canvas_timer image id and need to update only the target date.

To create a new timer through a conversation, use Timer Frames. Timer Frames are temporary drafts. Timers are committed image deployments returned by POST /v2/timer-frames/{timerFrameId}/save or listed through GET /v2/images?type=canvas_timer.

Update target date

Reference

Update only the target date for saved canvas_timer images. The request accepts absolute UTC/offset values, local date/time strings, and date-only values. Date-only values default to midnight. Deprecated classic_timer images are not supported.

  • targetDate is required.
  • timeZoneId is optional and accepts Windows or Olson ids.
  • When targetDate has no offset and timeZoneId is omitted, the timer's existing timezone is used.
curl -X PATCH https://dev.niftyimages.com/v2/timers/418344/target-date \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targetDate": "7/4/2026"
  }'
curl -X PATCH https://dev.niftyimages.com/v2/timers/418344/target-date \
  -H "Authorization: Bearer $NIFTYIMAGES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targetDate": "7/4/2026 12:00am",
    "timeZoneId": "America/New_York"
  }'
{
  "id": 418344,
  "imageType": "canvas_timer",
  "targetDateUtc": "2026-07-04T07:00:00Z",
  "timeZoneId": "Pacific Standard Time",
  "localTargetDate": "07/04/2026",
  "localTargetTime": "12:00 AM"
}