Create a timer
A new timer posts for the first time one interval from creation, not immediately. Messages can’t start with / or !, and support the same template variables as custom commands minus the argument ones ({channel}, {pick:a|b|c}, {random:1-100}, {list:name}, {uptime}, {ai:...}, … - see https://docs.tippage.com/chat-bot/variables). Max 20 timers. Requires timers:manage.
/timersAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
application/jsonnamestringrequiredmessagestringrequiredThe template. Can't start with / or !. Its fixed wording (everything outside {variables}) must fit in one 500-character chat message; the rendered chat line is cut to 500.
interval_minutesintegerrequiredinterval_max_minutesinteger | nullOmit or null for a fixed cadence.
min_chat_linesintegerlive_onlybooleanplatformsstring[]Which chat(s) the timer posts in. At least one.
enabledbooleanCreated.
timerChatTimerShow propertiesHide properties
idstringnamestringLabel shown in the dashboard - viewers never see it.
messagestringWhat the bot posts. Same template variables as custom commands minus the argument ones.
interval_minutesintegerinterval_max_minutesinteger | nullnull = fixed cadence. Set = a fresh random interval in [interval_minutes, interval_max_minutes] is rolled after every post.
min_chat_linesintegerThe timer waits until this many chat messages have been sent since its last post. 0 = no requirement. A due timer that hasn't met the bar posts as soon as chat catches up - it never skips a cycle.
live_onlybooleanOnly post while the streamer is live, judged per platform - the line goes to the chats whose channel is live right now. min_chat_lines counts the lines in every chat the timer posts in, added together.
platformsstring[]Which chat(s) the timer posts in. Default both. One schedule - when it fires, it posts once per connected platform in the set.
enabledbooleancreated_atstring<date-time>updated_atstring<date-time>Invalid fields (invalid_timer) or timer limit reached (limit_reached).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring