{
"errors": [
"You do not have sufficient permissions to access this resource. Please contact support."
]
}
{
"errors": [
"send_hour must be an integer between 0 and 23"
]
}
Sequences
Create a sequence
Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it.
Only name is required. Every other field has a sensible default: Kit fills in the account’s default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence.
Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they’ve received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won’t pick up future additions.
exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they’ll skip this sequence entirely.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kit Developer Documentation","colors":{"primary":"#44B1FF","light":"#F2EFE9","dark":"#1E1E1E"},"logo":{"light":"https://mintcdn.com/kit-314e57c1/7adJHuc_n17cs81K/logo/kit-logo-soft-black.svg?fit=max\u0026auto=format\u0026n=7adJHuc_n17cs81K\u0026q=85\u0026s=f8b2597b9e12c38f282a39af1e827443","dark":"https://mintcdn.com/kit-314e57c1/7adJHuc_n17cs81K/logo/kit-logo-warm-white.svg?fit=max\u0026auto=format\u0026n=7adJHuc_n17cs81K\u0026q=85\u0026s=4aa6d3d2cd08c65d6286c611a21e8321"},"favicon":"https://mintcdn.com/kit-314e57c1/e9nHA3E-BCD6lL7Q/logo/kit-favicon-dark.png?fit=max\u0026auto=format\u0026n=e9nHA3E-BCD6lL7Q\u0026q=85\u0026s=9183688d8f368eaade3cd6386335038b","api":{"examples":{"languages":["curl","ruby","javascript","go","php","python"]}},"background":{"color":{"light":"#FFFFFF","dark":"#1E1E1E"}},"navbar":{"links":[{"href":"https://app.kit.com/users/login","label":"Log in"}],"primary":{"type":"button","label":"Start free trial","href":"https://app.kit.com/users/signup?plan=1k"}},"footer":{"socials":{"x":"https://x.com/kit","github":"https://github.com/kit","linkedin":"https://www.linkedin.com/company/kit.com/posts"}},"seo":{"metatags":{"og:title":"Kit Developer Documentation","og:image":"/images/kit-hero.png","twitter:image":"/images/kit-hero.png"},"indexing":"all"},"fonts":{"heading":{"family":"KitSansBold","weight":400,"source":"https://cdn.kit.com/assets/fonts/KitSansBold.woff","format":"woff"},"body":{"family":"Libre Franklin","weight":400,"source":"https://fonts.gstatic.com/s/librefranklin/v18/jizOREVItHgc8qDIbSTKq4XkRg8T88bjFuXOnduhLsWkANDJTedX18mE.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Kit","icon":"house","href":"https://kit.com"},{"anchor":"Developer Community","icon":"slack","href":"https://kit.typeform.com/to/f8urvmPe"},{"anchor":"Blog","icon":"newspaper","href":"https://kit.com/resources"},{"anchor":"Support","icon":"messages-question","href":"https://kit.com/support"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kit-314e57c1","hasAudioNarration":false,"actualSubdomain":"kit-314e57c1","customDomains":["developers.kit.com"],"gitSource":{"type":"github","owner":"kit","repo":"developer-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5a6ceb51d0e31167ace8c","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":120},{"language":"default","tag":"Endpoints","count":96},{"language":"default","tag":"Plugins","count":39},{"language":"default","tag":"Building plugins","count":36},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"Plugin component library","count":15},{"language":"default","tag":"Subscribers","count":12},{"language":"default","tag":"Tags","count":12},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Kit App Store","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUS2zcLig.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUb2zcLig.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUQ2zcLig.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUR2zcLig.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUf2zc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUS2zcLig.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUb2zcLig.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUQ2zcLig.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUR2zcLig.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUf2zc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUS2zcLig.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUb2zcLig.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUQ2zcLig.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUR2zcLig.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Libre Franklin';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/librefranklin/v20/jizDREVItHgc8qDIbSTKq4XkRiUf2zc.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nstrong{font-weight:600!important}.prose a:not(.not-prose):not(.not-prose a):not(.card-group a){text-decoration-line:underline;text-decoration-style:solid;text-decoration-thickness:1px;text-underline-offset:2px;border:0;font-weight:600}.prose a:not(.not-prose):not(.not-prose a):not(.card-group a):hover{--tw-text-opacity: 1;color:rgb(106 110 114 / var(--tw-text-opacity, 1))}#navigation-items h5{font-family:\"Libre Franklin\"}li[id=\"topbar-cta-button\"]>a>div>span{color:#000000!important;font-weight:bold!important}li[id=\"topbar-cta-button\"]>a>div>svg>path{stroke:#000000!important;font-weight:bold!important}.dark li[id=\"topbar-cta-button\"]>a>div>span{color:#000000!important;font-weight:bold!important}li[id=\"topbar-cta-button\"]>a>span{background:#44b1ff!important}h1,h2,h3,h4,h5{letter-spacing:0!important}h2,h3,h4,h5,h6{font-family:\"Libre Franklin\"!important}#topbar-cta-button svg{display:none!important}.dark li[id=\"topbar-cta-button\"]>a>div>span,li[id=\"topbar-cta-button\"]>a>div>span{font-weight:600!important}#topbar-cta-button a{padding:6px 12px!important}#topbar-cta-button a>span{border-radius:8px!important;transition:all 0.2s ease!important}.nav-tag-pill-text{color:#92400e!important;background-color:#fef3c7!important}.dark .nav-tag-pill-text{color:#fde68a!important;background-color:rgb(146 64 14 / 0.45)!important}"}],"page":{"pagePath":"api-reference/sequences/create-a-sequence","slug":"/api-reference/sequences/create-a-sequence","pageMetadata":{"title":"Create a sequence","description":"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use [Create a sequence email](/api-reference/sequence-emails/create-a-sequence-email) to populate it.\n\nOnly `name` is required. Every other field has a sensible default: Kit fills in the account's default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via [Update a sequence](/api-reference/sequences/update-a-sequence).\n\nTwo behavioural toggles worth flagging up front. `repeat` controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with `repeat: true`, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. `hold` (evergreen) keeps subscribers active in the sequence after they've received every published email — useful when you plan to add more emails later. Without `hold`, subscribers transition to Completed and won't pick up future additions.\n\n`exclude_subscriber_sources` lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they'll skip this sequence entirely.\n\nFor end-user context, see the help articles on [creating and sending a sequence](https://help.kit.com/en/articles/2502629-creating-and-sending-a-sequence-in-kit), [restarting a sequence](https://help.kit.com/en/articles/5022528-restart-a-sequence), and [holding subscribers in evergreen sequences](https://help.kit.com/en/articles/5192801-how-to-hold-subscribers-in-evergreen-sequences).","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences","href":"/api-reference/sequences/create-a-sequence","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use \", _jsx(_components.a, {\n href: \"/api-reference/sequence-emails/create-a-sequence-email\",\n children: \"Create a sequence email\"\n }), \" to populate it.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Only \", _jsx(_components.code, {\n children: \"name\"\n }), \" is required. Every other field has a sensible default: Kit fills in the account’s default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via \", _jsx(_components.a, {\n href: \"/api-reference/sequences/update-a-sequence\",\n children: \"Update a sequence\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Two behavioural toggles worth flagging up front. \", _jsx(_components.code, {\n children: \"repeat\"\n }), \" controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with \", _jsx(_components.code, {\n children: \"repeat: true\"\n }), \", re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. \", _jsx(_components.code, {\n children: \"hold\"\n }), \" (evergreen) keeps subscribers active in the sequence after they’ve received every published email — useful when you plan to add more emails later. Without \", _jsx(_components.code, {\n children: \"hold\"\n }), \", subscribers transition to Completed and won’t pick up future additions.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"exclude_subscriber_sources\"\n }), \" lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they’ll skip this sequence entirely.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For end-user context, see the help articles on \", _jsx(_components.a, {\n href: \"https://help.kit.com/en/articles/2502629-creating-and-sending-a-sequence-in-kit\",\n children: \"creating and sending a sequence\"\n }), \", \", _jsx(_components.a, {\n href: \"https://help.kit.com/en/articles/5022528-restart-a-sequence\",\n children: \"restarting a sequence\"\n }), \", and \", _jsx(_components.a, {\n href: \"https://help.kit.com/en/articles/5192801-how-to-hold-subscribers-in-evergreen-sequences\",\n children: \"holding subscribers in evergreen sequences\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a sequence","description":"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use [Create a sequence email](/api-reference/sequence-emails/create-a-sequence-email) to populate it.\n\nOnly `name` is required. Every other field has a sensible default: Kit fills in the account's default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via [Update a sequence](/api-reference/sequences/update-a-sequence).\n\nTwo behavioural toggles worth flagging up front. `repeat` controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with `repeat: true`, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. `hold` (evergreen) keeps subscribers active in the sequence after they've received every published email — useful when you plan to add more emails later. Without `hold`, subscribers transition to Completed and won't pick up future additions.\n\n`exclude_subscriber_sources` lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they'll skip this sequence entirely.\n\nFor end-user context, see the help articles on [creating and sending a sequence](https://help.kit.com/en/articles/2502629-creating-and-sending-a-sequence-in-kit), [restarting a sequence](https://help.kit.com/en/articles/5022528-restart-a-sequence), and [holding subscribers in evergreen sequences](https://help.kit.com/en/articles/5192801-how-to-hold-subscribers-in-evergreen-sequences).","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences","href":"/api-reference/sequences/create-a-sequence","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a sequence","description":"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use [Create a sequence email](/api-reference/sequence-emails/create-a-sequence-email) to populate it.\n\nOnly `name` is required. Every other field has a sensible default: Kit fills in the account's default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via [Update a sequence](/api-reference/sequences/update-a-sequence).\n\nTwo behavioural toggles worth flagging up front. `repeat` controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with `repeat: true`, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. `hold` (evergreen) keeps subscribers active in the sequence after they've received every published email — useful when you plan to add more emails later. Without `hold`, subscribers transition to Completed and won't pick up future additions.\n\n`exclude_subscriber_sources` lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they'll skip this sequence entirely.\n\nFor end-user context, see the help articles on [creating and sending a sequence](https://help.kit.com/en/articles/2502629-creating-and-sending-a-sequence-in-kit), [restarting a sequence](https://help.kit.com/en/articles/5022528-restart-a-sequence), and [holding subscribers in evergreen sequences](https://help.kit.com/en/articles/5192801-how-to-hold-subscribers-in-evergreen-sequences).","tags":["Sequences"],"security":["c4faa48a-94f1-47fb-8580-d1dc73e07a6e","cdb6af24-7d07-4fff-b80f-9ed56bbf031e"],"parameters":[],"responses":{"201":"7b5ee391-4531-4cef-ae45-5d26c2f05a25","401":"a984f9cb-2c2d-4888-8757-97cbb10f9055","403":"1874bb06-2974-425c-b806-e9456803b6bb","422":"14b0eab1-fe26-49ff-97f5-a77db721b423"},"requestBody":"29ac3b9a-8d8b-4057-bc9f-4a52bf7fd1be","x-mcp":{"enabled":true},"method":"post","type":"path","servers":["1923906d-de32-41f9-bf65-94e3aebd9de5"],"path":"/v4/sequences","baseUrlOptions":["https://api.kit.com"],"title":"Create a sequence","codeSamples":[],"requestExampleLanguages":["bash","ruby","javascript","go","php","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence.","uniqueKey":"name","typeLabel":"string"},"email_address":{"type":"string","description":"The sending email address to use. Uses the account's sending email address if not provided.","uniqueKey":"email_address","typeLabel":"string"},"email_template_id":{"type":"integer","description":"Id of the email template to use.","uniqueKey":"email_template_id","typeLabel":"integer"},"send_days":{"type":"array","items":{"type":"string","uniqueKey":"send_days.items.[INDEX]","typeLabel":"string"},"description":"The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.","uniqueKey":"send_days","typeLabel":"string[]"},"send_hour":{"type":"integer","description":"The hour of the day to send the sequence at. Must be an integer between 0 and 23.","uniqueKey":"send_hour","typeLabel":"integer"},"time_zone":{"type":"string","description":"The timezone to use for the sequence. Must be a valid IANA timezone string.","uniqueKey":"time_zone","typeLabel":"string"},"active":{"type":"boolean","description":"`true` to activate the sequence, `false` to deactivate it.","uniqueKey":"active","typeLabel":"boolean"},"repeat":{"type":"boolean","description":"When `true`, subscribers can restart the sequence multiple times.","uniqueKey":"repeat","typeLabel":"boolean"},"hold":{"type":"boolean","description":"When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email.","uniqueKey":"hold","typeLabel":"boolean"},"exclude_subscriber_sources":{"type":"array","description":"The subscriber sources to exclude from the sequence.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of subscriber source to exclude. Must be one of: `tag`, `sequence`, `form`, `segment`.","isRequired":true,"uniqueKey":"exclude_subscriber_sources.items.[INDEX].type","typeLabel":"string"},"ids":{"type":"array","items":{"type":"integer","description":"The ids of the subscriber sources to exclude.","uniqueKey":"exclude_subscriber_sources.items.[INDEX].ids.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"exclude_subscriber_sources.items.[INDEX].ids","typeLabel":"integer[]"}},"required":["type","ids"],"uniqueKey":"exclude_subscriber_sources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"exclude_subscriber_sources","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"Full Series","email_address":"joe1150@ck.lol","email_template_id":38,"send_days":["monday","wednesday","friday"],"send_hour":9,"time_zone":"America/Los_Angeles","active":true,"repeat":true,"hold":true,"exclude_subscriber_sources":[{"type":"tag","ids":[3]},{"type":"sequence","ids":[30]}]},"examples":{"Example":{"title":"Example","value":{"name":"Full Series","email_address":"joe1150@ck.lol","email_template_id":38,"send_days":["monday","wednesday","friday"],"send_hour":9,"time_zone":"America/Los_Angeles","active":true,"repeat":true,"hold":true,"exclude_subscriber_sources":[{"type":"tag","ids":[3]},{"type":"sequence","ids":[30]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"7b5ee391-4531-4cef-ae45-5d26c2f05a25":{"description":"Creates a new sequence","content":{"application/json":{"schema":{"type":"object","properties":{"sequence":{"type":"object","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"sequence.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"sequence.name","typeLabel":"string"},"hold":{"type":"boolean","isRequired":true,"uniqueKey":"sequence.hold","typeLabel":"boolean"},"repeat":{"type":"boolean","isRequired":true,"uniqueKey":"sequence.repeat","typeLabel":"boolean"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"sequence.created_at","typeLabel":"string"},"updated_at":{"type":"string","isRequired":true,"uniqueKey":"sequence.updated_at","typeLabel":"string"},"email_address":{"type":"string","isRequired":true,"uniqueKey":"sequence.email_address","typeLabel":"string"},"email_template_id":{"type":"integer","isRequired":true,"uniqueKey":"sequence.email_template_id","typeLabel":"integer"},"send_days":{"type":"array","items":{"type":"string","uniqueKey":"sequence.send_days.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"sequence.send_days","typeLabel":"string[]"},"send_hour":{"type":"integer","isRequired":true,"uniqueKey":"sequence.send_hour","typeLabel":"integer"},"time_zone":{"type":"string","isRequired":true,"uniqueKey":"sequence.time_zone","typeLabel":"string"},"active":{"type":"boolean","isRequired":true,"uniqueKey":"sequence.active","typeLabel":"boolean"},"exclude_subscriber_sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"sequence.exclude_subscriber_sources.items.[INDEX].type","typeLabel":"string"},"ids":{"type":"array","items":{"type":"integer","uniqueKey":"sequence.exclude_subscriber_sources.items.[INDEX].ids.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"sequence.exclude_subscriber_sources.items.[INDEX].ids","typeLabel":"integer[]"}},"required":["type","ids"],"uniqueKey":"sequence.exclude_subscriber_sources.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"sequence.exclude_subscriber_sources","typeLabel":"object[]"},"email_count":{"type":"integer","uniqueKey":"sequence.email_count","typeLabel":"integer"},"subscriber_count":{"type":"integer","uniqueKey":"sequence.subscriber_count","typeLabel":"integer"}},"required":["id","name","hold","repeat","created_at","updated_at","email_address","email_template_id","send_days","send_hour","time_zone","active","exclude_subscriber_sources"],"isRequired":true,"uniqueKey":"sequence","typeLabel":"object"}},"required":["sequence"],"uniqueKey":"","typeLabel":"object"},"example":{"sequence":{"id":31,"name":"Full Series","hold":true,"repeat":true,"created_at":"2026-07-28T03:01:49Z","updated_at":"2026-07-28T03:01:49Z","email_address":"joe1150@ck.lol","email_template_id":38,"send_days":["monday","wednesday","friday"],"send_hour":9,"time_zone":"America/Los_Angeles","active":true,"exclude_subscriber_sources":[{"type":"sequence","ids":[30]},{"type":"tag","ids":[3]}],"email_count":0,"subscriber_count":0}},"examples":{"Example":{"title":"Example","value":{"sequence":{"id":31,"name":"Full Series","hold":true,"repeat":true,"created_at":"2026-07-28T03:01:49Z","updated_at":"2026-07-28T03:01:49Z","email_address":"joe1150@ck.lol","email_template_id":38,"send_days":["monday","wednesday","friday"],"send_hour":9,"time_zone":"America/Los_Angeles","active":true,"exclude_subscriber_sources":[{"type":"sequence","ids":[30]},{"type":"tag","ids":[3]}],"email_count":0,"subscriber_count":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"a984f9cb-2c2d-4888-8757-97cbb10f9055":{"description":"Returns a 401 if the token and/or account cannot be authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"example":{"errors":["The access token is invalid"]},"examples":{"Example":{"title":"Example","value":{"errors":["The access token is invalid"]}}},"exampleType":"examples"}},"exampleType":"examples"},"1874bb06-2974-425c-b806-e9456803b6bb":{"description":"Returns a 403 with an error message if the current account is unauthorized to create a sequence","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"example":{"errors":["You do not have sufficient permissions to access this resource. Please contact support."]},"examples":{"Example":{"title":"Example","value":{"errors":["You do not have sufficient permissions to access this resource. Please contact support."]}}},"exampleType":"examples"}},"exampleType":"examples"},"14b0eab1-fe26-49ff-97f5-a77db721b423":{"description":"Returns a 422 with an error message when one or more of the parameters were invalid","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"example":{"errors":["send_hour must be an integer between 0 and 23"]},"examples":{"Example":{"title":"Example","value":{"errors":["send_hour must be an integer between 0 and 23"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c4faa48a-94f1-47fb-8580-d1dc73e07a6e":{"API Key":{"description":"Authenticate API requests via an API Key","type":"apiKey","in":"header","name":"X-Kit-Api-Key","scopes":[],"schemeName":"API Key"}},"cdb6af24-7d07-4fff-b80f-9ed56bbf031e":{"OAuth2":{"description":"Authenticate API requests via an OAuth token","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://api.kit.com/v4/oauth/authorize","tokenUrl":"https://api.kit.com/v4/oauth/token","refreshUrl":"https://api.kit.com/v4/oauth/token","scopes":{"read":"Read access to Kit API v4","write":"Write access to Kit API v4"}}},"scopes":[],"schemeName":"OAuth2"}}},"servers":{"1923906d-de32-41f9-bf65-94e3aebd9de5":{"url":"https://api.kit.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Authenticate API requests via an API Key","type":"apiKey","in":"header","name":"X-Kit-Api-Key","scopes":[],"schemeName":"API Key"},"schema":{"title":"X-Kit-Api-Key","type":"string","description":"Authenticate API requests via an API Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API Key","name":"X-Kit-Api-Key"}],"title":"API Key"},{"schemes":[{"scheme":{"description":"Authenticate API requests via an OAuth token","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://api.kit.com/v4/oauth/authorize","tokenUrl":"https://api.kit.com/v4/oauth/token","refreshUrl":"https://api.kit.com/v4/oauth/token","scopes":{"read":"Read access to Kit API v4","write":"Write access to Kit API v4"}}},"scopes":[],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Authenticate API requests via an OAuth token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/v4.json"},"subdomain":"kit-314e57c1","siteName":"Kit Developer Documentation","title":"Kit Developer Documentation","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"API 4.0":{"href":"/api-reference/sequences/create-a-sequence","matchLevel":0},"API 5.0 (unstable)":{"href":"/api-reference/v5/ping/check-your-credentials","matchLevel":2},"API 3.0 (legacy)":{"href":"/api-reference/v3/account","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T22:49:42.662Z","originalFileLocation":"api-reference/sequences/create-a-sequence.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required. Every other field has a sensible default: Kit fills in the account\u0026#x27;s default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence. Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they\u0026#x27;ve received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won\u0026#x27;t pick up future additions. exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they\u0026#x27;ll skip this sequence entirely. For end-user context, see the help articles on creating and sending a sequence, restarting a sequence, and holding subscribers in evergreen sequences.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kit Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Kit Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required. Every other field has a sensible default: Kit fills in the account\u0026#x27;s default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence. Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they\u0026#x27;ve received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won\u0026#x27;t pick up future additions. exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they\u0026#x27;ll skip this sequence entirely. For end-user context, see the help articles on creating and sending a sequence, restarting a sequence, and holding subscribers in evergreen sequences.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kit Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.kit.com/api-reference/sequences/create-a-sequence\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kit-314e57c1.mintlify.site/images/kit-hero.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Kit Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required. Every other field has a sensible default: Kit fills in the account\u0026#x27;s default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence. Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they\u0026#x27;ve received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won\u0026#x27;t pick up future additions. exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they\u0026#x27;ll skip this sequence entirely. For end-user context, see the help articles on creating and sending a sequence, restarting a sequence, and holding subscribers in evergreen sequences.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kit-314e57c1.mintlify.site/images/kit-hero.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/kit-314e57c1/Pkdyit4Q00bMDtMW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kit Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#44B1FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.kit.com/api-reference/sequences/create-a-sequence\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sequences/create-a-sequence.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.kit.com/#organization\",\"name\":\"Kit Developer Documentation\",\"url\":\"https://developers.kit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kit-314e57c1/7adJHuc_n17cs81K/logo/kit-logo-soft-black.svg?fit=max\u0026auto=format\u0026n=7adJHuc_n17cs81K\u0026q=85\u0026s=f8b2597b9e12c38f282a39af1e827443\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.kit.com#website\",\"name\":\"Kit Developer Documentation\",\"url\":\"https://developers.kit.com\",\"publisher\":{\"@id\":\"https://developers.kit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence#webpage\",\"url\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence\",\"name\":\"Create a sequence\",\"description\":\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required. Every other field has a sensible default: Kit fills in the account's default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence. Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they've received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won't pick up future additions. exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they'll skip this sequence entirely. For end-user context, see the help articles on creating and sending a sequence, restarting a sequence, and holding subscribers in evergreen sequences.\",\"dateModified\":\"2026-11-11T22:49:42.662Z\",\"isPartOf\":{\"@id\":\"https://developers.kit.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developers.kit.com/api-reference/accounts/get-current-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sequences\",\"item\":\"https://developers.kit.com/api-reference/sequences/list-sequences\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a sequence\",\"item\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence#apireference\",\"headline\":\"Create a sequence\",\"name\":\"Create a sequence\",\"description\":\"Creates an empty sequence — the container that holds sequence emails. After creating the shell, use Create a sequence email to populate it. Only name is required. Every other field has a sensible default: Kit fills in the account's default sending address, a daily send schedule, and the account time zone — and any of these can be tuned later via Update a sequence. Two behavioural toggles worth flagging up front. repeat controls whether a subscriber can re-enter the sequence: by default a subscriber receives the emails once and is marked complete, but with repeat: true, re-adding the same subscriber via a Visual Automation, Rule, Bulk Action, or Import resets their position to the start. Filters and exclusions still apply across restarts. hold (evergreen) keeps subscribers active in the sequence after they've received every published email — useful when you plan to add more emails later. Without hold, subscribers transition to Completed and won't pick up future additions. exclude_subscriber_sources lets you exclude subscribers acquired via specific tags, sequences, forms, or segments — they'll skip this sequence entirely. For end-user context, see the help articles on creating and sending a sequence, restarting a sequence, and holding subscribers in evergreen sequences.\",\"url\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence\",\"mainEntityOfPage\":{\"@id\":\"https://developers.kit.com/api-reference/sequences/create-a-sequence#webpage\"},\"image\":\"https://developers.kit.com/images/kit-hero.png\",\"dateModified\":\"2026-11-11T22:49:42.662Z\",\"publisher\":{\"@id\":\"https://developers.kit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.kit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kit Developer Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kit Developer Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sequences/create-a-sequence.md","siteName":"Kit Developer Documentation","nav":{"global":{"anchors":[{"anchor":"Kit","icon":"house","href":"https://kit.com"},{"anchor":"Developer Community","icon":"slack","href":"https://kit.typeform.com/to/f8urvmPe"},{"anchor":"Blog","icon":"newspaper","href":"https://kit.com/resources"},{"anchor":"Support","icon":"messages-question","href":"https://kit.com/support"}]},"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/welcome"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Kit App Store","pages":[{"title":"Kit App Store","href":"/kit-app-store/overview"}]},{"tab":"Plugins","pages":[{"title":"Plugins","href":"/plugins/overview"}]},{"tab":"API Reference","versions":[{"version":"API 4.0","default":true,"groups":[{"group":"Getting started","boost":3,"pages":[{"title":"API Overview","sidebarTitle":"Overview","mode":"wide","href":"/api-reference/overview"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"}]},{"group":"Guides","pages":[{"group":"OAuth guides","pages":[{"title":"OAuth refresh token flow","href":"/api-reference/oauth-refresh-token-flow"},{"title":"Proof Key for Code Exchange (PKCE) flow","href":"/api-reference/oauth-proof-key-for-code-exchange-flow"},{"title":"OAuth token revocation","href":"/api-reference/oauth-token-revocation"}]},{"title":"Upgrading to V4","href":"/api-reference/upgrading-to-v4"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Bulk \u0026 async processing","href":"/api-reference/bulk-and-async-processing"},{"title":"Eventual consistency","href":"/api-reference/eventual-consistency"},{"title":"Dates","href":"/api-reference/dates"},{"title":"Email data retention","href":"/api-reference/email-data-retention"},{"title":"API response codes","sidebarTitle":"Response codes","href":"/api-reference/response-codes"},{"title":"Rate limits","href":"/api-reference/rate-limits"}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview","sidebarTitle":"Overview","href":"/webhooks/overview"},{"title":"Getting started with webhooks","sidebarTitle":"Getting started","href":"/webhooks/getting-started"},{"title":"Delivery format","sidebarTitle":"Delivery format","href":"/webhooks/delivery-format"},{"title":"Event types","sidebarTitle":"Event types","href":"/webhooks/event-types"},{"title":"Verifying signatures","sidebarTitle":"Verifying signatures","href":"/webhooks/verifying-signatures"},{"title":"Retries","sidebarTitle":"Retries","href":"/webhooks/retries"},{"title":"Delivery history","sidebarTitle":"Delivery history","href":"/webhooks/delivery-history"},{"title":"Errors and gating","sidebarTitle":"Errors","href":"/webhooks/errors"}]},{"group":"Endpoints","pages":[{"group":"Accounts","pages":[{"title":"Get current account","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/account","href":"/api-reference/accounts/get-current-account"},{"title":"List colors","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/account/colors","href":"/api-reference/accounts/list-colors"},{"title":"Update colors","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/account/colors","href":"/api-reference/accounts/update-colors"},{"title":"Get Creator Profile","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/account/creator_profile","href":"/api-reference/accounts/get-creator-profile"},{"title":"Get email stats","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/account/email_stats","href":"/api-reference/accounts/get-email-stats"},{"title":"Get growth stats","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/account/growth_stats","href":"/api-reference/accounts/get-growth-stats"}]},{"group":"Apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/apps","href":"/api-reference/apps/list-apps"},{"title":"Get an app","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/apps/{id}","href":"/api-reference/apps/get-an-app"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Create a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/broadcasts","href":"/api-reference/broadcasts/create-a-broadcast"},{"title":"Get stats for a list of broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/broadcasts/stats","href":"/api-reference/broadcasts/get-stats-for-a-list-of-broadcasts"},{"title":"Get link clicks for a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/broadcasts/{broadcast_id}/clicks","href":"/api-reference/broadcasts/get-link-clicks-for-a-broadcast"},{"title":"Get stats for a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/broadcasts/{broadcast_id}/stats","href":"/api-reference/broadcasts/get-stats-for-a-broadcast"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/broadcasts/{id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"Update a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/broadcasts/{id}","href":"/api-reference/broadcasts/update-a-broadcast"},{"title":"Delete a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/broadcasts/{id}","href":"/api-reference/broadcasts/delete-a-broadcast"}]},{"group":"Custom Fields","pages":[{"title":"Bulk create custom fields","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/custom_fields","href":"/api-reference/custom-fields/bulk-create-custom-fields"},{"title":"Bulk update subscriber custom field values","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/custom_fields/subscribers","href":"/api-reference/custom-fields/bulk-update-subscriber-custom-field-values"},{"title":"List custom fields","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/custom_fields","href":"/api-reference/custom-fields/list-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/custom_fields","href":"/api-reference/custom-fields/create-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/custom_fields/{id}","href":"/api-reference/custom-fields/update-a-custom-field"},{"title":"Delete custom field","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/custom_fields/{id}","href":"/api-reference/custom-fields/delete-custom-field"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/email_templates","href":"/api-reference/email-templates/list-email-templates"}]},{"group":"Forms","pages":[{"title":"Bulk add subscribers to forms","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/forms/subscribers","href":"/api-reference/forms/bulk-add-subscribers-to-forms"},{"title":"List forms","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/forms","href":"/api-reference/forms/list-forms"},{"title":"List subscribers for a form","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/forms/{form_id}/subscribers","href":"/api-reference/forms/list-subscribers-for-a-form"},{"title":"Add subscriber to form by email address","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/forms/{form_id}/subscribers","href":"/api-reference/forms/add-subscriber-to-form-by-email-address"},{"title":"Add subscriber to form","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/forms/{form_id}/subscribers/{id}","href":"/api-reference/forms/add-subscriber-to-form"}]},{"group":"Posts","pages":[{"title":"List posts","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/posts","href":"/api-reference/posts/list-posts"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/posts/{id}","href":"/api-reference/posts/get-a-post"}]},{"group":"Purchases","pages":[{"title":"List purchases","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/purchases","href":"/api-reference/purchases/list-purchases"},{"title":"Create a purchase","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/purchases","href":"/api-reference/purchases/create-a-purchase"},{"title":"Get a purchase","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/purchases/{id}","href":"/api-reference/purchases/get-a-purchase"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/segments","href":"/api-reference/segments/list-segments"}]},{"group":"Sequence Emails","pages":[{"title":"List sequence emails","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/sequences/{sequence_id}/emails","href":"/api-reference/sequence-emails/list-sequence-emails"},{"title":"Create a sequence email","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences/{sequence_id}/emails","href":"/api-reference/sequence-emails/create-a-sequence-email"},{"title":"Get a sequence email","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/sequences/{sequence_id}/emails/{id}","href":"/api-reference/sequence-emails/get-a-sequence-email"},{"title":"Update a sequence email","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/sequences/{sequence_id}/emails/{id}","href":"/api-reference/sequence-emails/update-a-sequence-email"},{"title":"Delete a sequence email","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/sequences/{sequence_id}/emails/{id}","href":"/api-reference/sequence-emails/delete-a-sequence-email"}]},{"group":"Sequences","pages":[{"title":"List sequences","description":"Returns every sequence on the account. A sequence is a self-contained set of automated emails — subscribers join, then receive each email in order, governed by per-email `delay_value` / `delay_unit` and the sequence's overall `send_days`, `send_hour`, and `time_zone` schedule.\n\nEach entry carries the schedule defaults plus three behavioural toggles: `active` (whether the sequence is delivering), `repeat` (whether subscribers can re-enter), and `hold` (whether subscribers stay active after receiving every published email — an evergreen pattern). See [Create a sequence](/api-reference/sequences/create-a-sequence) for the full sequence model.\n\nOnce you have a sequence's `id`, [List sequence emails](/api-reference/sequence-emails/list-sequence-emails) returns the individual emails inside it.\n\nFor end-user context on how creators build sequences, see the help articles on [creating and sending a sequence](https://help.kit.com/en/articles/2502629-creating-and-sending-a-sequence-in-kit) and [evergreen content](https://help.kit.com/en/articles/2502575-what-is-evergreen-content).","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/sequences","href":"/api-reference/sequences/list-sequences"},{"title":"Create a sequence","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences","href":"/api-reference/sequences/create-a-sequence"},{"title":"Get a sequence","description":"Fetches a single sequence by `id`. Use this when you need the current schedule, the `active` / `repeat` / `hold` flags, the configured `email_address` and `email_template_id`, or `exclude_subscriber_sources` for a known sequence — for example, to confirm settings before adding subscribers or to render an editor.\n\nFor the individual emails inside the sequence, use [List sequence emails](/api-reference/sequence-emails/list-sequence-emails). For the sequence model and field semantics, see [Create a sequence](/api-reference/sequences/create-a-sequence).","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/sequences/{id}","href":"/api-reference/sequences/get-a-sequence"},{"title":"Update a sequence","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/sequences/{id}","href":"/api-reference/sequences/update-a-sequence"},{"title":"Delete a sequence","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/sequences/{id}","href":"/api-reference/sequences/delete-a-sequence"},{"title":"List subscribers for a sequence","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/sequences/{sequence_id}/subscribers","href":"/api-reference/sequences/list-subscribers-for-a-sequence"},{"title":"Add subscriber to sequence by email address","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences/{sequence_id}/subscribers","href":"/api-reference/sequences/add-subscriber-to-sequence-by-email-address"},{"title":"Add subscriber to sequence","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/sequences/{sequence_id}/subscribers/{id}","href":"/api-reference/sequences/add-subscriber-to-sequence"}]},{"group":"Snippets","pages":[{"title":"List snippets","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/snippets","href":"/api-reference/snippets/list-snippets"},{"title":"Create a snippet","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/snippets","href":"/api-reference/snippets/create-a-snippet"},{"title":"Get a snippet","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/snippets/{id}","href":"/api-reference/snippets/get-a-snippet"},{"title":"Update a snippet","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/snippets/{id}","href":"/api-reference/snippets/update-a-snippet"}]},{"group":"Subscribers","pages":[{"title":"Bulk create subscribers","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"title":"List subscribers","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/subscribers","href":"/api-reference/subscribers/list-subscribers"},{"title":"Create a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/subscribers","href":"/api-reference/subscribers/create-a-subscriber"},{"title":"Filter subscribers by engagement, sign-up date, state, and tags","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/subscribers/filter","href":"/api-reference/subscribers/filter-subscribers-by-engagement-sign-up-date-state-and-tags"},{"title":"Get a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/subscribers/{id}","href":"/api-reference/subscribers/get-a-subscriber"},{"title":"Update a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/subscribers/{id}","href":"/api-reference/subscribers/update-a-subscriber"},{"title":"Unsubscribe subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/subscribers/{id}/unsubscribe","href":"/api-reference/subscribers/unsubscribe-subscriber"},{"title":"Pin a subscriber's location","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/subscribers/{subscriber_id}/location","href":"/api-reference/subscribers/pin-a-subscribers-location"},{"title":"Delete a subscriber's location","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/subscribers/{subscriber_id}/location","href":"/api-reference/subscribers/delete-a-subscribers-location"},{"title":"Update a subscriber's pinned location","deprecated":null,"version":null,"openapi":"/api-reference/v4.json patch /v4/subscribers/{subscriber_id}/location","href":"/api-reference/subscribers/update-a-subscribers-pinned-location"},{"title":"List stats for a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/subscribers/{subscriber_id}/stats","href":"/api-reference/subscribers/list-stats-for-a-subscriber"},{"title":"List tags for a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/subscribers/{subscriber_id}/tags","href":"/api-reference/subscribers/list-tags-for-a-subscriber"}]},{"group":"Tags","pages":[{"title":"Bulk create tags","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/tags","href":"/api-reference/tags/bulk-create-tags"},{"title":"Bulk delete tags","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/bulk/tags","href":"/api-reference/tags/bulk-delete-tags"},{"title":"Bulk tag subscribers","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/bulk/tags/subscribers","href":"/api-reference/tags/bulk-tag-subscribers"},{"title":"Bulk remove tags from subscribers","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/bulk/tags/subscribers","href":"/api-reference/tags/bulk-remove-tags-from-subscribers"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Update tag name","deprecated":null,"version":null,"openapi":"/api-reference/v4.json put /v4/tags/{id}","href":"/api-reference/tags/update-tag-name"},{"title":"List subscribers for a tag","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/tags/{tag_id}/subscribers","href":"/api-reference/tags/list-subscribers-for-a-tag"},{"title":"Tag a subscriber by email address","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/tags/{tag_id}/subscribers","href":"/api-reference/tags/tag-a-subscriber-by-email-address"},{"title":"Remove tag from subscriber by email address","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/tags/{tag_id}/subscribers","href":"/api-reference/tags/remove-tag-from-subscriber-by-email-address"},{"title":"Tag a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/tags/{tag_id}/subscribers/{id}","href":"/api-reference/tags/tag-a-subscriber"},{"title":"Remove tag from subscriber","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/tags/{tag_id}/subscribers/{id}","href":"/api-reference/tags/remove-tag-from-subscriber"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/webhook_endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/webhook_endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/webhook_endpoints/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/webhook_endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v4.json patch /v4/webhook_endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/webhook_endpoints/{id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Get webhook delivery details","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/webhook_endpoints/{id}/deliveries/{delivery_id}","href":"/api-reference/webhooks/get-webhook-delivery-details"},{"title":"Revoke the previous webhook endpoint secret","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/webhook_endpoints/{id}/revoke_previous_secret","href":"/api-reference/webhooks/revoke-the-previous-webhook-endpoint-secret"},{"title":"Rotate a webhook endpoint secret","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/webhook_endpoints/{id}/rotate_secret","href":"/api-reference/webhooks/rotate-a-webhook-endpoint-secret"}]},{"group":"Webhooks (Legacy)","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/v4.json get /v4/webhooks","href":"/api-reference/webhooks-legacy/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/v4.json post /v4/webhooks","href":"/api-reference/webhooks-legacy/create-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/v4.json delete /v4/webhooks/{id}","href":"/api-reference/webhooks-legacy/delete-a-webhook"}]}]}]},{"version":"API 5.0 (unstable)","pages":[{"title":"API 5.0 (unstable)","href":"/api-reference/v5/ping/check-your-credentials"}]},{"version":"API 3.0 (legacy)","pages":[{"title":"API 3.0 (legacy)","href":"/api-reference/v3/account"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Kit Developer Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}