1<!DOCTYPE html><html lang="en" dir="ltr" data-has-toc data-has-sidebar data-theme="dark" class="astro-bguv2lll"> <head><meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><title>Mailtimer public API | Mailtimer Docs</title><link rel="canonical" href="https://help.mailtimer.com/guides/mailtimer-public-api/"/><link rel="sitemap" href="/sitemap-index.xml"/><link rel="sitemap" href="https://help.mailtimer.com/sitemap-index.xml"/>
1<script src="https://plausible.io/js/script.js" data-domain="mailtimer.com" defer></script>
1<script>window.$crisp = []; window.CRISP_WEBSITE_ID = '992c6b53-e015-4d80-babc-383ab073e016'; ;(function () {d = document; s = d.createElement('script'); s.src = 'https://client.crisp.chat/l.js'; s.async = 1; d.getElementsByTagName('head')[0].appendChild(s)})()</script>
vendor: 57 bytes, line 1
1<script src="https://www.googletagmanager.com/gtag/js?id=
1G-RBVQDXGSPG
vendor: 11 bytes, line 1
1"></script>
1<script>
vendor: 127 bytes, line 1
1window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', '
1G-RBVQDXGSPG
vendor: 3 bytes, line 1
1');
1</script>
1<link rel="shortcut icon" href="/favicon.png" type="image/png"/><meta name="generator" content="Astro v4.6.3"/><meta name="generator" content="Starlight v0.21.5"/><meta property="og:title" content="Mailtimer public API"/><meta property="og:type" content="article"/><meta property="og:url" content="https://help.mailtimer.com/guides/mailtimer-public-api/"/><meta property="og:locale" content="en"/><meta property="og:description" content="A guide in my new Starlight docs site."/><meta property="og:site_name" content="Mailtimer Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:title" content="Mailtimer public API"/><meta name="twitter:description" content="A guide in my new Starlight docs site."/><meta name="description" content="A guide in my new Starlight docs site."/><meta name="twitter:site" content="/mailtimer"/>
1<script> 2 window.StarlightThemeProvider = (() => { 3 const storedTheme = 4 typeof localStorage !== 'undefined' && localStorage.getItem('starlight-theme'); 5 const theme = 6 storedTheme || 7 (window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark'); 8 document.documentElement.dataset.theme = theme === 'light' ? 'light' : 'dark'; 9 return { 10 updatePickers(theme = storedTheme || 'auto') { 11 document.querySelectorAll('starlight-theme-select').forEach((picker) => { 12 const select = picker.querySelector('select'); 13 if (select) select.value = theme; 14 /** @type {HTMLTemplateElement | null} */ 15 const tmpl = document.querySelector(`#theme-icons`); 16 const newIcon = tmpl && tmpl.content.querySelector('.' + theme); 17 if (newIcon) { 18 const oldIcon = picker.querySelector('svg.label-icon'); 19 if (oldIcon) { 20 oldIcon.replaceChildren(...newIcon.cloneNode(true).childNodes); 21 } 22 } 23 }); 24 }, 25 }; 26 })(); 27</script>
27<template id="theme-icons"><svg aria-hidden="true" class="light astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M5 12a1 1 0 0 0-1-1H3a1 1 0 0 0 0 2h1a1 1 0 0 0 1-1Zm.64 5-.71.71a1 1 0 0 0 0 1.41 1 1 0 0 0 1.41 0l.71-.71A1 1 0 0 0 5.64 17ZM12 5a1 1 0 0 0 1-1V3a1 1 0 0 0-2 0v1a1 1 0 0 0 1 1Zm5.66 2.34a1 1 0 0 0 .7-.29l.71-.71a1 1 0 1 0-1.41-1.41l-.66.71a1 1 0 0 0 0 1.41 1 1 0 0 0 .66.29Zm-12-.29a1 1 0 0 0 1.41 0 1 1 0 0 0 0-1.41l-.71-.71a1.004 1.004 0 1 0-1.43 1.41l.73.71ZM21 11h-1a1 1 0 0 0 0 2h1a1 1 0 0 0 0-2Zm-2.64 6A1 1 0 0 0 17 18.36l.71.71a1 1 0 0 0 1.41 0 1 1 0 0 0 0-1.41l-.76-.66ZM12 6.5a5.5 5.5 0 1 0 5.5 5.5A5.51 5.51 0 0 0 12 6.5Zm0 9a3.5 3.5 0 1 1 0-7 3.5 3.5 0 0 1 0 7Zm0 3.5a1 1 0 0 0-1 1v1a1 1 0 0 0 2 0v-1a1 1 0 0 0-1-1Z"/></svg> <svg aria-hidden="true" class="dark astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21.64 13a1 1 0 0 0-1.05-.14 8.049 8.049 0 0 1-3.37.73 8.15 8.15 0 0 1-8.14-8.1 8.59 8.59 0 0 1 .25-2A1 1 0 0 0 8 2.36a10.14 10.14 0 1 0 14 11.69 1 1 0 0 0-.36-1.05Zm-9.5 6.69A8.14 8.14 0 0 1 7.08 5.22v.27a10.15 10.15 0 0 0 10.14 10.14 9.784 9.784 0 0 0 2.1-.22 8.11 8.11 0 0 1-7.18 4.32v-.04Z"/></svg> <svg aria-hidden="true" class="auto astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21 14h-1V7a3 3 0 0 0-3-3H7a3 3 0 0 0-3 3v7H3a1 1 0 0 0-1 1v2a3 3 0 0 0 3 3h14a3 3 0 0 0 3-3v-2a1 1 0 0 0-1-1ZM6 7a1 1 0 0 1 1-1h10a1 1 0 0 1 1 1v7H6V7Zm14 10a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1v-1h16v1Z"/></svg> </template><link rel="stylesheet" href="/_astro/index.BsC2KTtW.css">
27<script type="module" src="/_astro/hoisted.DkKaCe66.js"></script>
vendor: 1 bytes, line 27
27
28<script type="module" src="/_astro/page.CZ0TFQCk.js"></script>
28</head> <body class="astro-bguv2lll"> <a href="#_top" class="astro-7q3lir66">Skip to content</a> <div class="page sl-flex astro-vrdttmbt"> <header class="header astro-vrdttmbt"><div class="header sl-flex astro-kmkmnagf"> <div class="title-wrapper sl-flex astro-kmkmnagf"> <a href="/" class="site-title sl-flex astro-m46x6ez3"> <span class="astro-m46x6ez3"> Mailtimer Docs </span> </a> </div> <div class="sl-flex astro-kmkmnagf"> <site-search data-translations="{"placeholder":"Search"}" class="astro-v37mnknz"> <button data-open-modal disabled class="astro-v37mnknz"> <svg aria-label="Search" class="astro-v37mnknz astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21.71 20.29 18 16.61A9 9 0 1 0 16.61 18l3.68 3.68a.999.999 0 0 0 1.42 0 1 1 0 0 0 0-1.39ZM11 18a7 7 0 1 1 0-14 7 7 0 0 1 0 14Z"/></svg> <span class="sl-hidden md:sl-block astro-v37mnknz" aria-hidden="true">Search</span> <svg aria-label="(Press / to Search)" class="sl-hidden md:sl-block astro-v37mnknz astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M17 2H7a5 5 0 0 0-5 5v10a5 5 0 0 0 5 5h10a5 5 0 0 0 5-5V7a5 5 0 0 0-5-5Zm3 15a3 3 0 0 1-3 3H7a3 3 0 0 1-3-3V7a3 3 0 0 1 3-3h10a3 3 0 0 1 3 3v10Z"/><path d="M15.293 6.707a1 1 0 1 1 1.414 1.414l-8.485 8.486a1 1 0 0 1-1.414-1.415l8.485-8.485Z"/></svg> </button> <dialog style="padding:0" aria-label="Search" class="astro-v37mnknz"> <div class="dialog-frame sl-flex astro-v37mnknz"> <button data-close-modal class="sl-flex md:sl-hidden astro-v37mnknz"> Cancel </button> <div class="search-container astro-v37mnknz"> <div id="starlight__search" class="astro-v37mnknz"></div> </div> </div> </dialog> </site-search> </div> <div class="sl-hidden md:sl-flex right-group astro-kmkmnagf"> <div class="sl-flex social-icons astro-kmkmnagf"> <a href="https://twitter.com/mailtimer" rel="me" class="sl-flex astro-wy4te6ga"><span class="sr-only astro-wy4te6ga">Twitter</span><svg aria-hidden="true" class="astro-wy4te6ga astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M24 4.4a10 10 0 0 1-2.83.78 5.05 5.05 0 0 0 2.17-2.79 9.7 9.7 0 0 1-3.13 1.23 4.89 4.89 0 0 0-5.94-1.03 5 5 0 0 0-2.17 2.38 5.15 5.15 0 0 0-.3 3.25c-1.95-.1-3.86-.63-5.61-1.53a14.04 14.04 0 0 1-4.52-3.74 5.2 5.2 0 0 0-.09 4.91c.39.74.94 1.35 1.61 1.82a4.77 4.77 0 0 1-2.23-.63v.06c0 1.16.4 2.29 1.12 3.18a4.9 4.9 0 0 0 2.84 1.74c-.73.22-1.5.26-2.24.12a4.89 4.89 0 0 0 4.59 3.49A9.78 9.78 0 0 1 0 19.73 13.65 13.65 0 0 0 7.55 22a13.63 13.63 0 0 0 9.96-4.16A14.26 14.26 0 0 0 21.6 7.65V7c.94-.72 1.75-1.6 2.4-2.6Z"/></svg> </a> </div> <starlight-theme-select> <label style="--sl-select-width: 6.25em" class="astro-4yphtoen"> <span class="sr-only astro-4yphtoen">Select theme</span> <svg aria-hidden="true" class="icon label-icon astro-4yphtoen astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21 14h-1V7a3 3 0 0 0-3-3H7a3 3 0 0 0-3 3v7H3a1 1 0 0 0-1 1v2a3 3 0 0 0 3 3h14a3 3 0 0 0 3-3v-2a1 1 0 0 0-1-1ZM6 7a1 1 0 0 1 1-1h10a1 1 0 0 1 1 1v7H6V7Zm14 10a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1v-1h16v1Z"/></svg> <select value="auto" class="astro-4yphtoen"> <option value="dark" class="astro-4yphtoen">Dark</option><option value="light" class="astro-4yphtoen">Light</option><option value="auto" selected="true" class="astro-4yphtoen">Auto</option> </select> <svg aria-hidden="true" class="icon caret astro-4yphtoen astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M17 9.17a1 1 0 0 0-1.41 0L12 12.71 8.46 9.17a1 1 0 1 0-1.41 1.42l4.24 4.24a1.002 1.002 0 0 0 1.42 0L17 10.59a1.002 1.002 0 0 0 0-1.42Z"/></svg> </label> </starlight-theme-select>
28<script> 29 StarlightThemeProvider.updatePickers(); 30</script>
30 </div> </div> </header> <nav class="sidebar astro-vrdttmbt" aria-label="Main"> <starlight-menu-button class="astro-jif73yzw"> <button aria-expanded="false" aria-label="Menu" aria-controls="starlight__sidebar" class="sl-flex md:sl-hidden astro-jif73yzw"> <svg aria-hidden="true" class="astro-jif73yzw astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M3 8h18a1 1 0 1 0 0-2H3a1 1 0 0 0 0 2Zm18 8H3a1 1 0 0 0 0 2h18a1 1 0 0 0 0-2Zm0-5H3a1 1 0 0 0 0 2h18a1 1 0 0 0 0-2Z"/></svg> </button> </starlight-menu-button> <div id="starlight__sidebar" class="sidebar-pane astro-vrdttmbt"> <div class="sidebar-content sl-flex astro-vrdttmbt"> <ul class="top-level astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/" class="large astro-3ii7xxms"> <span class="astro-3ii7xxms">Home</span> </a> </li><li class="astro-3ii7xxms"> <details open class="astro-3ii7xxms"> <summary class="astro-3ii7xxms"> <div class="group-label astro-3ii7xxms"> <span class="large astro-3ii7xxms">Creating Timers</span> </div> <svg aria-hidden="true" class="caret astro-3ii7xxms astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.25rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </summary> <ul class="astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/guides/timer-types-and-use-cases/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Timer types & use-cases</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/clickable-timers/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Clickable timers</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/timer-expiration-behavior/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Timer expiration behavior</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/add-background-image/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Add background image</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/add-custom-font/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Add a custom font</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/transparent-background/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Using transparent backgrounds</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/how-time-zone-support-works/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">How time zone support works</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/editing-active-timer/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Editing active timers</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/can-active-timer-be-deleted/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Deleting active timers</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/timer-stats-tracking/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Timer stats tracking</span> </a> </li> </ul> </details> </li><li class="astro-3ii7xxms"> <details open class="astro-3ii7xxms"> <summary class="astro-3ii7xxms"> <div class="group-label astro-3ii7xxms"> <span class="large astro-3ii7xxms">Publishing Timers</span> </div> <svg aria-hidden="true" class="caret astro-3ii7xxms astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.25rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </summary> <ul class="astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/guides/which-email-clients-support-animated-timers/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Which clients support animated timers?</span> </a> </li> </ul> </details> </li><li class="astro-3ii7xxms"> <details open class="astro-3ii7xxms"> <summary class="astro-3ii7xxms"> <div class="group-label astro-3ii7xxms"> <span class="large astro-3ii7xxms">How-to guides</span> </div> <svg aria-hidden="true" class="caret astro-3ii7xxms astro-c6vsoqas" width="16" height="16" viewB
30ox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.25rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </summary> <ul class="astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/guides/how-to-add-a-custom-domain/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Add a custom domain</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/how-to-countdown-timer-gmail/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Insert timer into Gmail</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/how-to-countdown-timer-klaviyo/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Insert timer into Klaviyo</span> </a> </li> </ul> </details> </li><li class="astro-3ii7xxms"> <details open class="astro-3ii7xxms"> <summary class="astro-3ii7xxms"> <div class="group-label astro-3ii7xxms"> <span class="large astro-3ii7xxms">For Developers</span> </div> <svg aria-hidden="true" class="caret astro-3ii7xxms astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.25rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </summary> <ul class="astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/guides/mailtimer-public-api/" aria-current="page" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Mailtimer public API</span> </a> </li> </ul> </details> </li><li class="astro-3ii7xxms"> <details open class="astro-3ii7xxms"> <summary class="astro-3ii7xxms"> <div class="group-label astro-3ii7xxms"> <span class="large astro-3ii7xxms">Account</span> </div> <svg aria-hidden="true" class="caret astro-3ii7xxms astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.25rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </summary> <ul class="astro-3ii7xxms"> <li class="astro-3ii7xxms"> <a href="/guides/where-to-download-invoices/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">Where can I download my invoices?</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/what-is-a-view-credit/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">What is a view credit?</span> </a> </li><li class="astro-3ii7xxms"> <a href="/guides/what-happens-when-credits-run-out/" class="astro-3ii7xxms"> <span class="astro-3ii7xxms">What happens when credits run out?</span> </a> </li> </ul> </details> </li> </ul> <div class="md:sl-hidden"> <div class="mobile-preferences sl-flex astro-wu23bvmt"> <div class="sl-flex social-icons astro-wu23bvmt"> <a href="https://twitter.com/mailtimer" rel="me" class="sl-flex astro-wy4te6ga"><span class="sr-only astro-wy4te6ga">Twitter</span><svg aria-hidden="true" class="astro-wy4te6ga astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M24 4.4a10 10 0 0 1-2.83.78 5.05 5.05 0 0 0 2.17-2.79 9.7 9.7 0 0 1-3.13 1.23 4.89 4.89 0 0 0-5.94-1.03 5 5 0 0 0-2.17 2.38 5.15 5.15 0 0 0-.3 3.25c-1.95-.1-3.86-.63-5.61-1.53a14.04 14.04 0 0 1-4.52-3.74 5.2 5.2 0 0 0-.09 4.91c.39.74.94 1.35 1.61 1.82a4.77 4.77 0 0 1-2.23-.63v.06c0 1.16.4 2.29 1.12 3.18a4.9 4.9 0 0 0 2.84 1.74c-.73.22-1.5.26-2.24.12a4.89 4.89 0 0 0 4.59 3.49A9.78 9.78 0 0 1 0 19.73 13.65 13.65 0 0 0 7.55 22a13.63 13.63 0 0 0 9.96-4.16A14.26 14.26 0 0 0 21.6 7.65V7c.94-.72 1.75-1.6 2.4-2.6Z"/></svg> </a> </div> <starlight-theme-select> <label style="--sl-select-width: 6.25em" class="astro-4yphtoen"> <span class="sr-only astro-4yphtoen">Select theme</span> <svg aria-hidden="true" class="icon label-icon astro-4yphtoen astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21 14h-1V7a3 3 0 0 0-3-3H7a3 3 0 0 0-3 3v7H3a1 1 0 0 0-1 1v2a3 3 0 0 0 3 3h14a3 3 0 0 0 3-3v-2a1 1 0 0 0-1-1ZM6 7a1 1 0 0 1 1-1h10a1 1 0 0 1 1 1v7H6V7Zm14 10a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1v-1h16v1Z"/></svg> <select value="auto" class="astro-4yphtoen"> <option value="dark" class="astro-4yphtoen">Dark</option><option value="light" class="astro-4yphtoen">Light</option><option value="auto" selected="true" class="astro-4yphtoen">Auto</option> </select> <svg aria-hidden="true" class="icon caret astro-4yphtoen astro-c6vsoqas" width="16" height="16" viewB
30ox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M17 9.17a1 1 0 0 0-1.41 0L12 12.71 8.46 9.17a1 1 0 1 0-1.41 1.42l4.24 4.24a1.002 1.002 0 0 0 1.42 0L17 10.59a1.002 1.002 0 0 0 0-1.42Z"/></svg> </label> </starlight-theme-select>
30<script> 31 StarlightThemeProvider.updatePickers(); 32</script>
32 </div> </div> </div> </div> </nav> <div class="main-frame astro-vrdttmbt"> <div class="lg:sl-flex astro-67yu43on"> <aside class="right-sidebar-container astro-67yu43on"> <div class="right-sidebar astro-67yu43on"> <div class="lg:sl-hidden astro-pb3aqygn"><mobile-starlight-toc data-min-h="2" data-max-h="3" class="astro-doynk5tl"><nav aria-labelledby="starlight__on-this-page--mobile" class="astro-doynk5tl"><details id="starlight__mobile-toc" class="astro-doynk5tl"><summary id="starlight__on-this-page--mobile" class="sl-flex astro-doynk5tl"><div class="toggle sl-flex astro-doynk5tl">On this page<svg aria-hidden="true" class="caret astro-doynk5tl astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </div><span class="display-current astro-doynk5tl"></span></summary><div class="dropdown astro-doynk5tl"><ul class="isMobile astro-g2bywc46" style="--depth: 0;"> <li class="astro-g2bywc46" style="--depth: 0;"> <a href="#_top" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Overview</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#api-base" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">API base</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#authentication" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Authentication</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#manage-timers" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Manage timers</span> </a> <ul class="isMobile astro-g2bywc46" style="--depth: 1;"> <li class="astro-g2bywc46" style="--depth: 1;"> <a href="#list-timers" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">List timers</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#get-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Get timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#clone-duplicate-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Clone (duplicate) timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#delete-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Delete timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#update-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Update timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#create-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Create timer</span> </a> </li> </ul> </li> </ul> </div></details></nav></mobile-starlight-toc></div><div class="right-sidebar-panel sl-hidden lg:sl-block astro-pb3aqygn"><div class="sl-container astro-pb3aqygn"><starlight-toc data-min-h="2" data-max-h="3"><nav aria-labelledby="starlight__on-this-page"><h2 id="starlight__on-this-page">On this page</h2><ul class="astro-g2bywc46" style="--depth: 0;"> <li class="astro-g2bywc46" style="--depth: 0;"> <a href="#_top" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Overview</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#api-base" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">API base</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#authentication" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Authentication</span> </a> </li><li class="astro-g2bywc46" style="--depth: 0;"> <a href="#manage-timers" class="astro-g2bywc46" style="--depth: 0;"> <span class="astro-g2bywc46" style="--depth: 0;">Manage timers</span> </a> <ul class="astro-g2bywc46" style="--depth: 1;"> <li class="astro-g2bywc46" style="--depth: 1;"> <a href="#list-timers" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">List timers</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#get-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Get timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#clone-duplicate-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Clone (duplicate) timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#delete-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Delete timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#update-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Update timer</span> </a> </li><li class="astro-g2bywc46" style="--depth: 1;"> <a href="#create-timer" class="astro-g2bywc46" style="--depth: 1;"> <span class="astro-g2bywc46" style="--depth: 1;">Create timer</span> </a> </li> </ul> </li> </ul> </nav></starlight-toc></div></div> </div> </aside> <div class="main-pane astro-67yu43on">
32 <main data-pagefind-body lang="en" dir="ltr" class="astro-bguv2lll"> <div class="content-panel astro-7nkwcw3z"> <div class="sl-container astro-7nkwcw3z"> <h1 id="_top" class="astro-j6tvhyss">Mailtimer public API</h1> </div> </div> <div class="content-panel astro-7nkwcw3z"> <div class="sl-container astro-7nkwcw3z"> <div class="sl-markdown-content"> <p>Mailtimerâs public API is available to all paid accounts. It allows you to create, update and delete timers programmatically.</p> 33<h2 id="api-base">API base</h2> 34<p>All the API endpoints described in this article are relative to the base URL: <code dir="auto">https://api.mailtimer.io</code></p> 35<h2 id="authentication">Authentication</h2> 36<p>To access the API, you will need the API key that you will find in your <a href="https://app.mailtimer.io/account">account</a>:</p> 37<center> 38 <img src="/img/mailtimer-public-api/account.jpg" alt="Generate API key screenshot" width="50%"> 39</center> 40<p>This API key should be included in the <code dir="auto">X-API-Key</code> HTTP header. Unauthenticated responses will return a <code dir="auto">HTTP 401 Unauthorized</code> code.</p> 41<p>Hereâs a request example using cURL: <code dir="auto">curl -X GET https://api.mailtimer.io/users/me/ -H "X-API-Key: <YOUR_API_KEY>"</code></p> 42<h2 id="manage-timers">Manage timers</h2> 43<h3 id="list-timers">List timers</h3> 44<p><code dir="auto">GET /timers</code></p> 45<p>Parameters:</p> 46<ul> 47<li>page (number)</li> 48</ul> 49<h3 id="get-timer">Get timer</h3> 50<p><code dir="auto">GET /timers/<timer_id></code></p> 51<h3 id="clone-duplicate-timer">Clone (duplicate) timer</h3> 52<p><code dir="auto">POST /timers/<timer_id>/clone</code></p> 53<h3 id="delete-timer">Delete timer</h3> 54<p><code dir="auto">DELETE /timers/<timer_id></code></p> 55<h3 id="update-timer">Update timer</h3> 56<p><code dir="auto">POST /timers/<timer_id></code></p> 57<p>Parameters:</p> 58<ul> 59<li>name (string)</li> 60<li>is_enabled (boolean)</li> 61<li>template (number): timer template id [1..9]</li> 62<li>type (string): standard | eg1 (start when email is opened) | eg2 (start when email is sent) | dynamic</li> 63<li>ts_end (string): format âYYYYMMDD HHmmâ</li> 64<li>show_d, show_h, show_m, show_s (boolean): show/hide days, hours, minutes, seconds</li> 65<li>bg_color (string): background HEX color. Empty for transparent background</li> 66<li>matte_color (string): matte HEX color (only for transparent background)</li> 67<li>bg_url (string): background image URL</li> 68<li>tz (string): timezone (example: Europe/Berlin), list</li> 69<li>rounded_corners 70<ul> 71<li>is_enabled (boolean)</li> 72<li>radius (number): [0..100]</li> 73</ul> 74</li> 75<li>links 76<ul> 77<li>is_enabled (boolean)</li> 78<li>url_active (string)</li> 79<li>url_expired (string)</li> 80</ul> 81</li> 82<li>expire 83<ul> 84<li>mode (number): 0-hide timer, 1-show zeros, 2-show message, 3-reset and restart</li> 85<li>msg_line1 (string): only for âshow messageâ mode</li> 86</ul> 87</li> 88<li>title 89<ul> 90<li>show (boolean): show or hide the title</li> 91<li>text (string)</li> 92<li>font_size (number)</li> 93<li>color (string): title color in HEX format</li> 94</ul> 95</li> 96<li>dividers 97<ul> 98<li>show (boolean): show or hide the dividers</li> 99<li>color (string): dividers color in HEX format</li> 100</ul> 101</li> 102<li>labels 103<ul> 104<li>font_size (number)</li> 105<li>color (string): labels color in HEX format</li> 106<li>label_d (string): custom label for âDaysâ</li> 107<li>label_h (string): custom label for âHoursâ</li> 108<li>label_m (string): custom label for âMinutesâ</li> 109<li>label_s (string): custom label for âSecondsâ</li> 110</ul> 111</li> 112<li>counter 113<ul> 114<li>font_size (number)</li> 115<li>color (string): counter color in HEX format</li> 116<li>has_lead_zeros (boolean)</li> 117<li>bg_color (string): background color in HEX format</li> 118</ul> 119</li> 120</ul> 121<h3 id="create-timer">Create timer</h3> 122<p><code dir="auto">POST /timers</code></p> 123<p>Parameters: same as for update timer endpoint.</p> </div> <footer class="astro-3yyafb3n"> <div class="meta sl-flex astro-3yyafb3n"> </div> <div class="pagination-links astro-u2l5gyhi" dir="ltr"> <a href="/guides/how-to-countdown-timer-klaviyo/" rel="prev" class="astro-u2l5gyhi"> <svg aria-hidden="true" class="astro-u2l5gyhi astro-c6vsoqas" width="16" height="16" viewB
123ox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-u2l5gyhi"> Previous <br class="astro-u2l5gyhi"> <span class="link-title astro-u2l5gyhi">Insert timer into Klaviyo</span> </span> </a> <a href="/guides/where-to-download-invoices/" rel="next" class="astro-u2l5gyhi"> <svg aria-hidden="true" class="astro-u2l5gyhi astro-c6vsoqas" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17.92 11.62a1.001 1.001 0 0 0-.21-.33l-5-5a1.003 1.003 0 1 0-1.42 1.42l3.3 3.29H7a1 1 0 0 0 0 2h7.59l-3.3 3.29a1.002 1.002 0 0 0 .325 1.639 1 1 0 0 0 1.095-.219l5-5a1 1 0 0 0 .21-.33 1 1 0 0 0 0-.76Z"/></svg> <span class="astro-u2l5gyhi"> Next <br class="astro-u2l5gyhi"> <span class="link-title astro-u2l5gyhi">Where can I download my invoices?</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div>
123<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v4bc70e2c01a94c73b74392e4234840661791215815920" integrity="sha512-L0ha0OXavK/8okipN9F8BtP84dg9DUhPERbBXzwI6dgTA55d2+yweo3pn5CSFYs45/r8md2+xvUPtTdvTNRfjA==" data-cf-beacon='{"version":"2024.11.0","token":"a0fae298590a4e698f71a53a0c4bb215","r":1,"spa":2}' crossorigin="anonymous"></script>
123 124</body></html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.