A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Zapier","colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00"},"logo":{"light":"https://mintcdn.com/zapier-82f0e938/uPbDC0jSuXgHCaWD/logo/light.svg?fit=max\u0026auto=format\u0026n=uPbDC0jSuXgHCaWD\u0026q=85\u0026s=b6a37289cb22ac1a9681572651874765","dark":"https://mintcdn.com/zapier-82f0e938/b1yEJJDZ7v1EncmE/logo/dark.svg?fit=max\u0026auto=format\u0026n=b1yEJJDZ7v1EncmE\u0026q=85\u0026s=2c393c141bc7fbb0051aaa46b103f5e8","href":"https://zapier.com"},"favicon":"https://mintcdn.com/zapier-82f0e938/1jtyk4mqAs_J-p30/favicon.png?fit=max\u0026auto=format\u0026n=1jtyk4mqAs_J-p30\u0026q=85\u0026s=a26d7c83b71f1cdec48ae963245f407f","api":{"openapi":["https://api.zapier.com/schema","api-reference/specs/trigger-inbox.yaml","api-reference/specs/actions.yaml","api-reference/specs/connections.yaml","api-reference/specs/agentic-management.yaml"]},"background":{"color":{"light":"#FFFEFB"}},"navbar":{"primary":{"type":"button","label":"Sign Up","href":"https://zapier.com/sign-up"}},"footer":{},"seo":{"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-K7GFJTV"}},"contextual":{"options":["copy","view",{"title":"Open in ChatGPT","description":"Ask ChatGPT about this page","icon":"/images/logos/branded/openai.svg","href":{"base":"https://chatgpt.com/","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Claude","description":"Ask Claude about this page","icon":"/images/logos/branded/claude.svg","href":{"base":"https://claude.ai/new","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Perplexity","description":"Ask Perplexity about this page","icon":"/images/logos/branded/perplexity.svg","href":{"base":"https://www.perplexity.ai/search","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Claude Code","description":"Use this page in Claude Code","icon":"/images/logos/branded/claude.svg","href":{"base":"claude://code/new","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}},{"title":"Open in Codex","description":"Use this page in Codex","icon":"/images/logos/branded/openai.svg","href":{"base":"codex://new","query":[{"key":"prompt","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}},{"title":"Open in Cursor","description":"Use this page in Cursor","icon":"/images/logos/branded/cursor.svg","href":{"base":"cursor://anysphere.cursor-deeplink/prompt","query":[{"key":"text","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}}],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://community.zapier.com/"},{"anchor":"Changelog","icon":"rss","href":"/white-label/changelog"},{"anchor":"Contact Us","icon":"envelope","href":"https://developer.zapier.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zapier-82f0e938","hasAudioNarration":false,"actualSubdomain":"zapier-82f0e938","customDomains":["docs.zapier.com"],"gitSource":{"type":"gitlab","owner":"zapier/public-api","repo":"public-api-docs","projectId":56036607,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae451bebaed4ab3ebb9c9c4","collectionId":"3f51afaa-6461-4274-9567-fc59245fe957","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae451bebaed4ab3ebb9c9c4"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae451bebaed4ab3ebb9c9c4","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Build a Zapier integration","count":149},{"language":"default","tag":"Developer Platform","count":149},{"language":"default","tag":"Embed Zapier","count":105},{"language":"default","tag":"Powered by Zapier","count":86},{"language":"default","tag":"Use Zapier in your tools","count":79},{"language":"default","tag":"Zapier MCP","count":67},{"language":"default","tag":"API reference","count":60},{"language":"default","tag":"Build with UI","count":52},{"language":"default","tag":"API specification","count":50},{"language":"default","tag":"Get started","count":46}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"starterQuestions":[{"_id":"6ac8f1f2b9b3f8640f05a146","deploymentId":"67001931f47db52dbf2b872a","questionText":"How do I build a public Zapier integration?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:54.782Z","updatedAt":"2026-10-09T13:53:54.782Z","__v":0},{"_id":"6ac8f1e5b9b3f8640f05a0d1","deploymentId":"67001931f47db52dbf2b872a","questionText":"What's the difference between the SDK and Platform CLI?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:41.586Z","updatedAt":"2026-10-09T13:53:41.586Z","__v":0},{"_id":"6ac8f1d4b9b3f8640f05a051","deploymentId":"67001931f47db52dbf2b872a","questionText":"How do I connect Zapier MCP to my MCP client?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:24.465Z","updatedAt":"2026-10-09T13:53:24.465Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Degular Display - Semibold\";src:url(https://fonts.zapier.com/Degular/DegularDisplay-Semibold.woff2);font-display:fallback;font-weight:400}@font-face{font-family:\"Serrif\";src:url(/fonts/serrif-300.woff2) format('woff2');font-display:swap;font-weight:300;font-style:normal}@font-face{font-family:\"Degular Display\";src:url(/fonts/degular-display-500.woff2) format('woff2');font-display:swap;font-weight:500;font-style:normal}@font-face{font-family:\"Degular Display\";src:url(/fonts/degular-display-600.woff2) format('woff2');font-display:swap;font-weight:600;font-style:normal}h2,h3,h4,header h1{font-family:\"Degular Display - Semibold\";font-weight:400!important;letter-spacing:.08rem!important}#chat-assistant-floating-input,.chat-assistant-floating-input,[data-component-part=chat-assistant-floating-input]{display:none!important}.card h2{font-size:1.2rem}.card code{text-decoration:none}:root:not(.dark) .card,:root:not(.dark) .code-block,:root:not(.dark) .code-block pre,:root:not(.dark) .code-block-background,:root:not(.dark) .code-group,:root:not(.dark) .code-group pre,:root:not(.dark) .shiki{background-color:#fffefb!important}.cta-button,.docs-nav-label{letter-spacing:.01em;text-decoration:none!important}.cta-button{display:inline-flex;align-items:center;gap:8px;padding:12px 24px;width:fit-content;background:#ff4f00;color:#fff!important;font-weight:600;font-size:15px;border:0;border-radius:8px;box-shadow:0 2px 8px rgba(255,79,0,.25);transition:all .2s ease;margin:1em 0}.cta-button:hover{background:#e64600;color:#fff!important;text-decoration:none!important;box-shadow:0 4px 12px rgba(255,79,0,.35);transform:translateY(-1px)}.cta-button:active{transform:translateY(0);box-shadow:0 1px 4px rgba(255,79,0,.3)}blockquote.sr-only+h2{margin-top:0}#navbar a[href=\"https://zapier.com\"],#navbar a[href=\"https://zapier.com\"] img{padding-right:0!important;margin-right:0!important}.docs-nav-label{color:#201515!important;font-family:\"Degular Display - Medium\",ui-sans-serif,system-ui,sans-serif;font-weight:400;font-size:1.5rem;margin-left:-.6rem;transition:color .15s ease;vertical-align:middle;cursor:pointer}.docs-nav-label:hover{color:#939084!important;text-decoration:none!important}.dark .docs-nav-label{color:#fffefb!important}.dark .docs-nav-label:hover{color:#c5c0b1!important}[role=menu]:focus,[role=menu]:focus-visible{outline-width:1px}footer:not(#zapier-universal-footer){display:none!important}#zapier-universal-footer{display:block!important;background-color:#fffdf9;font-family:'Inter',Helvetica,arial,sans-serif;font-size:14px;line-height:24px;color:#201515;-webkit-font-smoothing:antialiased;width:100%;margin-top:2rem}.dark #zapier-universal-footer{background-color:#2d2e2e;color:#fffdf9}.zuf{max-width:1200px;margin:0 auto;padding:30px;display:grid;grid-template-rows:auto;grid-template-columns:100%;grid-template-areas:'links' 'socials' 'logo' 'meta';justify-items:center;align-items:center;gap:30px}@media (min-width:650px){.zuf{grid-template-columns:max-content 1fr;grid-template-areas:'links links' 'socials socials' 'logo meta'}}@media (min-width:980px){.zuf{grid-template-columns:max-content 1fr;grid-template-areas:'socials links' 'logo meta'}}.zuf-row--bottom,.zuf-row--top{display:contents}.zuf-socials{grid-area:socials;display:inline-flex;flex-wrap:wrap;align-items:center;gap:10px}@media (min-width:980px){.zuf-socials{justify-self:start}}.zuf-follow{font-size:14px;line-height:20px;font-weight:400;color:#574e4c;white-space:nowrap}.dark .zuf-follow{color:#a8a5a0}.zuf-icon{display:flex;align-items:center;justify-content:center;width:30px;height:30px;border-radius:100%;background-color:#a8a5a0;text-decoration:none!important;transition:background-color .15s ease}.zuf-icon img,.zuf-icon svg{width:16px;height:16px;fill:#fffdf9}.dark .zuf-icon{background-color:#403f3e}.dark .zuf-icon svg,.dark .zuf-logo path{fill:#fffdf9}.zuf-icon[aria-label*=Facebook]:focus,.zuf-icon[aria-label*=Facebook]:hover{background-color:#3b5998;outline:0}.zuf-icon[aria-label*=LinkedIn]:focus,.zuf-icon[aria-label*=LinkedIn]:hover{background-color:#0976b4;outline:0}.zuf-icon[aria-label*=X]:focus,.zuf-icon[aria-label*=X]:hover{background-color:#00aced;outline:0}.zuf-icon[aria-label*=YouTube]:focus,.zuf-icon[aria-label*=YouTube]:hover{background-color:#e52d27;outline:0}.zuf-icon[aria-label*=blog]:focus,.zuf-icon[aria-label*=blog]:hover{background-color:#ff4f00;outline:0}.zuf-links{grid-area:links;display:flex;flex-wrap:wrap;align-items:center;justify-content:center;column-gap:12.5px;row-gap:10px;width:100%}@media (min-width:980px){.zuf-links{justify-content:flex-end}}.zuf-links a{font-family:'Inter',Helvetica,arial,sans-serif;font-size:14px;line-height:24px;font-weight:500;color:#201515!important;padding:0 5px;white-space:nowrap;text-decoration:none!important}.zuf-links a:focus,.zuf-links a:hover{color:#3d4592!important;outline:0}.dark .zuf-links a{color:#fffdf9!important}.dark .zuf-links a:focus,.dark .zuf-links a:hover,.dark .zuf-meta a:focus,.dark .zuf-meta a:hover{color:#90a1ed!important}.zuf-logo,.zuf-meta a{text-decoration:none!important}.zuf-logo{grid-area:logo;display:inline-flex;align-items:center}.zuf-logo svg{display:block}.zuf-logo path{fill:#201515}.zuf-logo path[fill=\"#FF4F00\"]{fill:#ff4f00!important}@media (min-width:650px){.zuf-logo{justify-self:start}}.zuf-meta{grid-area:meta;font-size:14px;line-height:24px;font-weight:400;color:#574e4c;display:flex;flex-wrap:wrap;align-items:center;justify-content:center;row-gap:10px}.dark .zuf-meta{color:#a8a5a0}.zuf-meta a{padding:5px 10px;color:#574e4c!important}.zuf-meta a:focus,.zuf-meta a:hover{color:#3d4592!important;outline:0}.dark .zuf-meta a{color:#a8a5a0!important}@media (min-width:650px){.zuf-meta{justify-self:end;justify-content:flex-end}}.zuf-meta span{margin-right:10px}@media (max-width:979px){.zuf{padding:20px}}"},{"filePath":"index.css","content":".docs-landing{width:100%;margin:0 auto}#navbar{background:#fffef8!important;backdrop-filter:none!important}.dark #navbar{background:#18181b!important}.docs-landing-hero-bg{background:#201515}.docs-landing-hero-bg .dl-hero-title{color:#fff}.docs-landing-hero-bg .docs-landing-lead{color:rgba(255,255,255,.6)}.dark .docs-landing-hero-bg{background:#26201f;border-bottom:1px solid rgba(255,255,255,.08)}.docs-landing-hero{display:grid;grid-template-columns:minmax(0,1fr);gap:clamp(1.5rem,3.5vw,2.5rem);align-items:center;max-width:1180px;margin:0 auto;padding:48px clamp(1.25rem,4vw,2rem) clamp(1.25rem,2.5vw,1.75rem)}.dl-hero-copy,.docs-landing-hero-inner{text-align:center}.dl-hero-copy{max-width:640px;margin:0 auto}.docs-landing-eyebrow{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.75rem;font-weight:600;letter-spacing:.14em;text-transform:uppercase;color:#605d52;margin:0 0 1.25rem}.docs-landing-title{font-family:\"Degular Display - Semibold\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(2.25rem,4.5vw,3.25rem);line-height:1.08;font-weight:400!important;margin:0 0 1rem;letter-spacing:.08rem!important}.docs-landing-lead{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:1rem;line-height:1.5;color:#201515;margin:0 auto;max-width:62ch}.dark .docs-landing-lead{color:var(--muted-foreground, #a1a1aa)}.docs-landing-media{border-radius:14px;overflow:hidden;box-shadow:0 1px 2px rgba(15,23,42,.06),0 12px 40px rgba(15,23,42,.12);border:1px solid rgba(255,79,0,.12);background:rgba(255,79,0,.04)}.docs-landing-video{display:block;width:100%;height:auto;vertical-align:middle}.docs-landing-products{max-width:1180px;margin:0 auto;padding:clamp(2.5rem,5vw,4rem) clamp(1.25rem,4vw,2rem) clamp(3rem,6vw,5rem)}.docs-landing-section-title{font-family:\"Degular Display - Semibold\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(1.5rem,2.5vw,1.875rem);font-weight:400!important;text-align:left;margin:0 0 2.25rem;letter-spacing:.08rem!important}.dl-hero-title{font-family:\"Degular Display\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(2.5rem,4.8vw,3.5rem);line-height:1.1;font-weight:500;letter-spacing:-.03em!important;color:var(--foreground, #18181b);margin:0 0 .6875rem}.dark .dl-hero-demo code,.dark .dl-hero-title{color:var(--foreground, #fafafa)}.dl-hero-title-accent{color:#ff4f00}.dark .dl-hero-title-accent{color:#ff8a5c}.dl-demo-panel,.dl-hero-demo{border:1px solid rgba(9,9,11,.1);overflow:hidden}.dl-hero-demo{display:flex;align-items:center;justify-content:center;aspect-ratio:1/1;min-height:fit-content;padding:clamp(1rem,3vw,1.75rem);border-radius:10px;background-image:url(/images/pattern-abstract.jpg);background-size:cover;background-position:center;background-repeat:no-repeat}.dark .dl-demo-panel,.dark .dl-hero-demo{border-color:rgba(255,255,255,.12)}.dl-demo-panel{width:100%;border-radius:12px;background:#fff;box-shadow:0 1px 2px rgba(15,23,42,.06),0 12px 40px rgba(15,23,42,.14)}.dark .dl-demo-panel{background:#18181b}.dl-demo-clients{display:flex;flex-wrap:wrap;align-items:center;gap:.5rem;padding:.5rem .75rem;border-bottom:1px solid rgba(9,9,11,.08)}.dark .dl-demo-clients{border-bottom-color:rgba(255,255,255,.1)}.dl-demo-chip{width:36px;height:36px;border-radius:8px;border:1px solid rgba(9,9,11,.1);background:#fff;flex:none;margin:0!important}.dark .dl-demo-chip{border-color:rgba(255,255,255,.14)}.dl-demo-chip--padded{padding:6px}.dl-demo-arch-agents{display:flex;gap:.625rem;padding:1rem 1rem .75rem}.dl-demo-arch-col{flex:1;display:flex;flex-direction:column;gap:.375rem}.dl-demo-arch-label{font-size:.6875rem;font-weight:500;color:var(--muted-foreground, #71717a);margin:0 0 .125rem;letter-spacing:.01em}.dl-demo-arch-label--spacer{visibility:hidden;pointer-events:none;user-select:none}.dl-demo-arch-chip{display:flex;align-items:center;gap:.4375rem;padding:.3125rem .5625rem;border-radius:7px;border:1px solid rgba(9,9,11,.1);background:#fff;font-size:.75rem;font-weight:500;color:#09090b;line-height:1;white-space:nowrap}.dl-demo-arch-chip--muted{background:0 0;border-style:dashed;color:var(--muted-foreground, #71717a)}.dl-demo-arch-chip--logo{justify-content:center;padding:.375rem;width:36px;height:36px}.dl-demo-arch-icon{width:22px;height:22px;border-radius:4px;flex:none}.dl-demo-arch-chip--icon-pad .dl-demo-arch-icon{padding:3px}.dl-demo-arch-merge{position:relative;height:28px;margin:0 1rem}.dl-demo-arch-merge::before{content:'';position:absolute;left:25%;right:25%;top:0;height:14px;border-left:1px solid rgba(9,9,11,.1);border-right:1px solid rgba(9,9,11,.1);border-bottom:1px solid rgba(9,9,11,.1);border-bottom-left-radius:4px;border-bottom-right-radius:4px}.dl-demo-arch-merge::after{content:'';position:absolute;left:50%;transform:translateX(-50%);top:14px;bottom:0;width:1px;background:rgba(9,9,11,.1)}.dl-demo-arch-zapier{display:flex;align-items:center;justify-content:center;gap:.5rem;margin:0 1rem;padding:.625rem 1rem;border:1px solid rgba(9,9,11,.1);border-radius:10px;background:#fff}.dl-demo-arch-stem{display:flex;justify-content:center;height:20px}.dl-demo-arch-stem::after{content:'';width:1px;height:100%;background:rgba(9,9,11,.1)}.dl-demo-arch-apps{display:flex;flex-wrap:wrap;align-items:center;justify-content:center;gap:.375rem;padding:0 1rem .875rem}.dl-demo-arch-app{display:inline-flex;align-items:center;padding:.25rem .625rem;border-radius:6px;border:1px solid rgba(9,9,11,.1);background:#fff;font-size:.6875rem;font-weight:500;color:#09090b;white-space:nowrap}.dl-demo-arch-app--more{background:0 0;border-color:#e06c2c;color:#e06c2c;font-weight:600;text-decoration:none}.dl-demo-arch-app--more:hover{background:rgba(224,108,44,.06)}.dark .dl-demo-arch-stem::after{background:rgba(255,255,255,.1)}.dark .dl-demo-arch-app,.dark .dl-demo-arch-chip{background:rgba(255,255,255,.06);border-color:rgba(255,255,255,.12);color:#fafafa}.dl-demo-arch-zapier-badge{font-size:.8125rem;font-weight:600;color:#09090b;letter-spacing:-.01em}.dl-demo-arch-zapier-plus{font-size:.8125rem;font-weight:600;color:#e06c2c}.dark .dl-demo-arch-chip--muted{background:0 0;border-color:rgba(255,255,255,.15);color:var(--muted-foreground, #a1a1aa)}.dark .dl-demo-arch-merge::before,.dark .dl-demo-arch-zapier{border-color:rgba(255,255,255,.1)}.dark .dl-demo-arch-merge::after{background:rgba(255,255,255,.1)}.dark .dl-demo-arch-zapier{background:rgba(255,255,255,.04)}.dark .dl-demo-arch-zapier-badge{color:#fafafa}.dl-demo-more{display:inline-flex;align-items:center;justify-content:center;width:36px;height:36px;border-radius:8px;border:1px dashed rgba(9,9,11,.22);font-size:.9375rem;font-weight:500;line-height:1;color:var(--muted-foreground, #52525b);flex:none}.dark .dl-demo-more{border-color:rgba(255,255,255,.2);color:var(--muted-foreground, #a1a1aa)}.dl-demo-body{display:flex;flex-direction:column;gap:.375rem;padding:.5625rem .75rem .625rem}.dl-demo-prompt,.dl-demo-row{padding:.4375rem .625rem;border:1px solid rgba(9,9,11,.1);border-radius:7px}.dl-demo-prompt{font-size:.75rem;color:var(--muted-foreground, #52525b)}.dl-demo-row{display:flex;align-items:center;justify-content:space-between;gap:1rem}.dark .dl-demo-prompt,.dark .dl-demo-row{border-color:rgba(255,255,255,.12)}.dl-demo-status{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00}.dl-demo-action{display:flex;align-items:center;justify-content:space-between;gap:.75rem;padding:.375rem .625rem;border-left:2px solid #ff4f00;border-radius:0 7px 7px 0;background:rgba(9,9,11,.03)}.dark .dl-demo-action{background:rgba(255,255,255,.04)}.dl-demo-action span,.dl-demo-foot{font-size:.75rem;color:var(--muted-foreground, #52525b)}.dl-demo-action span{text-align:right}.dl-demo-foot{display:flex;align-items:center;justify-content:space-between;gap:1rem;padding-top:.25rem}.dl-hero-demo code{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;font-size:.75rem;background:0 0;border:0;padding:0;color:var(--foreground, #18181b)}.dl-section{max-width:1180px;margin:0 auto;padding:clamp(1.5rem,3vw,2.25rem) clamp(1.25rem,4vw,2rem)}.dl-eyebrow{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00;margin:0 0 .4375rem}.dl-heading{font-size:clamp(1.375rem,2.4vw,1.75rem);line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 .5rem;max-width:40ch}.dark .dl-heading{color:var(--foreground, #fafafa)}.dl-lead{font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0 0 1.25rem;max-width:68ch}.dark .dl-lead{color:var(--muted-foreground, #a1a1aa)}.dl-grid{display:grid;gap:.75rem;align-items:stretch}.dl-grid--2{grid-template-columns:repeat(2,minmax(0,1fr))}.dl-grid--3{grid-template-columns:repeat(3,minmax(0,1fr))}.dl-grid--4{grid-template-columns:repeat(4,minmax(0,1fr))}.dl-card{display:flex;flex-direction:column;gap:.5rem;padding:1.125rem 1.25rem 1.25rem;border:1px solid rgba(9,9,11,.1);background:#f8f4f0}.dark .dl-card{border-color:rgba(255,255,255,.12);background:rgba(255,255,255,.02)}.dl-card-mark{align-self:flex-start;margin-bottom:.25rem;color:#ff4f00}.dl-card-eyebrow{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00;margin:0}.dl-card-title{font-family:\"Serrif\",ui-serif,serif;font-size:1.5rem;font-weight:300;line-height:1.1;letter-spacing:-.03em;color:var(--foreground, #18181b);margin:0}.dark .dl-card-title{color:var(--foreground, #fafafa)}.dl-card-desc{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0}.dark .dl-card-desc,.dark .dl-pill{color:var(--muted-foreground, #a1a1aa)}.dl-pills{display:flex;flex-wrap:wrap;gap:.375rem;margin:.125rem 0 0}.dl-pill{font-size:.75rem;line-height:1;padding:.375rem .625rem;border-radius:999px;border:1px solid rgba(9,9,11,.14);color:var(--muted-foreground, #52525b);white-space:nowrap}.dark .dl-pill{border-color:rgba(255,255,255,.16)}.dl-pill>a{color:inherit!important;text-decoration:none!important}.dl-pill:has(>a):hover{border-color:rgba(9,9,11,.34)}.dark .dl-pill:has(>a):hover{border-color:rgba(255,255,255,.34)}.dl-pill--accent{border-color:rgba(255,79,0,.35);background:rgba(255,79,0,.06);color:#ff4f00}.dark .dl-pill--accent{border-color:rgba(255,79,0,.45);color:#ff8a5c}.dl-code{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;font-size:.8125rem;line-height:1.7;background:rgba(9,9,11,.04);border-radius:8px;padding:.75rem .875rem;margin:.125rem 0;overflow-x:auto;color:var(--foreground, #18181b)}.dl-code span{display:block;white-space:pre}.dl-code--shell span::before{content:\"\\276F \";color:#ff4f00}.dark .dl-code{background:rgba(255,255,255,.05);color:var(--foreground, #fafafa)}.dl-cta{margin-top:auto;padding-top:.5rem;font-size:.875rem;font-weight:600;color:#ff4f00!important;text-decoration:none!important}.dl-cta:hover{text-decoration:underline!important}@media screen and (max-width:1024px){.dl-grid--3,.dl-grid--4{grid-template-columns:repeat(2,minmax(0,1fr))}}@media screen and (max-width:640px){.dl-grid--2,.dl-grid--3,.dl-grid--4{grid-template-columns:1fr}}.docs-landing-next{max-width:1180px;margin:0 auto;padding:clamp(1.5rem,3vw,2.25rem) clamp(1.25rem,4vw,2rem) clamp(2.25rem,4vw,3.25rem)}.docs-landing-next-title{font-size:2rem;line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 1.25rem}.dark .docs-landing-next-title{color:var(--foreground, #fafafa)}.docs-landing-next-grid{display:grid;grid-template-columns:repeat(4,minmax(0,1fr));column-gap:clamp(1.5rem,4vw,3rem)}.docs-landing-next-item{position:relative;display:block;padding:.875rem 0 1.25rem;border-top:1px solid rgba(9,9,11,.12);text-decoration:none!important;transition:border-top-color .2s ease}.docs-landing-next-item:hover{border-top-color:#ff4f00}.dark .docs-landing-next-item{border-top-color:rgba(255,255,255,.14)}.docs-landing-next-item-title{display:block;font-size:1rem;font-weight:600;color:var(--foreground, #18181b);margin-bottom:.25rem}.docs-landing-next-item-title::after{content:\" \\2192\";color:#ff4f00}.dark .docs-landing-next-item-title{color:var(--foreground, #fafafa)}.docs-landing-next-item:hover .docs-landing-next-item-title{text-decoration:underline}.docs-landing-next-item-desc{display:block;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b)}.dark .docs-landing-next-item-desc{color:var(--muted-foreground, #a1a1aa)}@media screen and (max-width:768px){.docs-landing-next-grid{grid-template-columns:1fr}}.hero-container{display:flex;flex-direction:row;align-items:center;justify-content:center;text-align:left;padding:6rem 2rem;width:80%;border-bottom:2px solid #ff4f00;margin:0 auto}.hero-text{width:600px;margin-right:2rem}@media screen and (max-width:1024px){.docs-landing-hero{grid-template-columns:1fr}.docs-landing-media{max-width:640px;margin:0 auto}}@media screen and (max-width:1300px){.hero-container{flex-direction:column;text-align:center}.hero-text{margin-right:0;margin-bottom:2rem}.hero-video{max-width:600px}}.dl-section-heading{font-size:2rem;line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 1.25rem}.dark .dl-section-heading{color:var(--foreground, #fafafa)}.dl-bands{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:.75rem}.dl-band,.dl-band-main{display:flex;flex-direction:column}.dl-band{border:1px solid rgba(9,9,11,.1);overflow:hidden;background:#f8f4f0}.dark .dl-band{border-color:rgba(255,255,255,.12);background:rgba(255,255,255,.02)}.dl-band-main{gap:.5rem;padding:1.125rem 1.25rem 1.25rem;border-bottom:1px solid rgba(9,9,11,.1)}.dark .dl-band-main{background:rgba(255,255,255,.02);border-bottom-color:rgba(255,255,255,.12)}.dl-band-badge{align-self:flex-start;margin:0;padding:.1875rem .4375rem;border:1px solid rgba(255,79,0,.4);border-radius:5px;font-size:.625rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00}.dl-band-title{font-family:\"Serrif\",ui-serif,serif;font-size:1.5rem;font-weight:300!important;line-height:1.1;letter-spacing:-.03em!important;color:var(--foreground, #18181b);margin:.125rem 0 0!important}.dark .dl-band-title{color:var(--foreground, #fafafa)}.dl-band-icon,.dl-band-title-mark{align-self:flex-start;margin-bottom:16px;color:#ff4f00}.dl-band-icon{margin-bottom:8px}.dl-band-desc{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0;max-width:none}.dark .dl-band-desc{color:var(--muted-foreground, #a1a1aa)}.dl-band-main .dl-hero-demo{box-shadow:none;margin-top:.375rem}.dl-band-media{display:block;width:100%;height:auto;border:1px solid rgba(9,9,11,.1);border-radius:10px;margin:.375rem 0 0!important}.dark .dl-band-media{border-color:rgba(255,255,255,.12)}.dl-band-list{display:flex;flex:1;flex-direction:column}.dl-band-row{position:relative;display:grid;grid-template-columns:28px 1fr;grid-template-rows:auto auto;column-gap:.625rem;row-gap:.1875rem;align-items:center;flex:1;padding:.8125rem 2.25rem .8125rem 1.25rem;border-bottom:1px solid rgba(9,9,11,.08);text-decoration:none!important;transition:background .15s ease}.dl-band-row .dl-band-row-icon{grid-row:1/-1;align-self:center}.dl-band-row .dl-band-row-desc,.dl-band-row .dl-band-row-title{grid-column:2}.dl-band-row:not(:has(.dl-band-row-icon)){grid-template-columns:1fr}.dl-band-row:not(:has(.dl-band-row-icon)) .dl-band-row-desc,.dl-band-row:not(:has(.dl-band-row-icon)) .dl-band-row-title{grid-column:1}.dark .dl-band-row{border-bottom-color:rgba(255,255,255,.1)}.dl-band-row:last-child{border-bottom:none}.dl-band-row:hover{background:rgba(255,79,0,.04)}.dl-band-row::after{content:\"\\2192\";position:absolute;top:50%;right:1rem;transform:translateY(-50%);font-size:1rem;color:#ff4f00;transition:transform .15s ease}.dl-band-row:hover::after{transform:translateY(-50%) translateX(2px)}.dl-band-row>a,.docs-landing-next-item>a{position:absolute;inset:0;z-index:1}.dl-band-row>a:focus-visible,.docs-landing-next-item>a:focus-visible{outline:2px solid #ff4f00;outline-offset:-2px}.dl-band-row-icon{display:flex;align-items:center;justify-content:center;flex-shrink:0;width:28px;height:28px;color:#ff4f00}.dark .dl-band-row-icon{color:#ff8a5c}.dl-band-row-icon svg{width:16px;height:16px}.dl-band-row-title{font-size:.9375rem;font-weight:600;color:var(--foreground, #18181b)}.dark .dl-band-row-title{color:var(--foreground, #fafafa)}.dl-band-row:hover .dl-band-row-title{text-decoration:underline}.dl-band-row-desc{font-size:.875rem;line-height:1.5;color:var(--muted-foreground, #52525b)}.dark .dl-band-row-desc{color:var(--muted-foreground, #a1a1aa)}@media screen and (max-width:900px){.dl-bands{grid-template-columns:1fr}}"}],"page":{"pagePath":"api-reference/workflow/zaps/create-a-zap","slug":"/api-reference/workflow/zaps/create-a-zap","pageMetadata":{"title":"Create a Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### When using OAuth\n\nThis endpoint requires the `zap:write`, or `zap:all` OAuth scopes.","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps","href":"/api-reference/workflow/zaps/create-a-zap","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 code: \"code\",\n h4: \"h4\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This URL creates a Zap based on the given steps and title.\"\n }), \"\\n\", _jsx(_components.h4, {\n children: \"When using OAuth\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This endpoint requires the \", _jsx(_components.code, {\n children: \"zap:write\"\n }), \", or \", _jsx(_components.code, {\n children: \"zap:all\"\n }), \" OAuth scopes.\"]\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 Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### When using OAuth\n\nThis endpoint requires the `zap:write`, or `zap:all` OAuth scopes.","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps","href":"/api-reference/workflow/zaps/create-a-zap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/zapier-82f0e938/f426fe1f80e04ec5/content/welcome.js","/_mintlify/custom/zapier-82f0e938/8e22ee5176c0f2d3/content/page-view.js","/_mintlify/custom/zapier-82f0e938/ba23268896a334a3/content/events-core.js","/_mintlify/custom/zapier-82f0e938/a4a4aa1a440a45f6/content/webmcp.js","/_mintlify/custom/zapier-82f0e938/00b5c2b78afe2715/logo-nav.js","/_mintlify/custom/zapier-82f0e938/4312bb950916a05a/universal-footer.js"],"openApiReferenceData":{"operation":{"operationId":"post-zaps","description":"This URL creates a Zap based on the given steps and title.\n\n#### When using OAuth\n\nThis endpoint requires the `zap:write`, or `zap:all` OAuth scopes.","summary":"Create a Zap","parameters":["f0df469b-db59-491c-831e-3c248934c5bb"],"tags":["Zaps"],"requestBody":"e7e48fbb-e400-48d5-a8f5-7326f9a26d96","security":["49366cb4-de82-4b19-8015-611ca25e3fa3"],"responses":{"201":"f950b3c3-dc02-4032-a02c-80bc4edf071b","400":"e91c30b9-8ecd-44df-abba-04c970b029fa","401":"7d3a0d04-7cd8-4ac3-a0f5-6fbc566f230b","403":"709f8f21-e8bf-4d62-b4bd-c86e06ed8871","409":"2b05bab2-bc60-4ce0-ae1c-edd9e4352b1f","429":"f1fcc8ea-e3a5-442b-a7f7-ea5096ec1324","500":"68a5e952-2365-41c0-b75c-7fb0a3be0b82","503":"0d3518a6-2635-4cdd-9233-5246ae7ab1cc","504":"5521ee07-d485-4fa8-9366-febca3087e2e"},"method":"post","type":"path","servers":["754752ae-c9ce-43e6-9996-f70b087afa0e"],"path":"/v2/zaps","baseUrlOptions":["https://api.zapier.com"],"title":"Create a Zap","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f0df469b-db59-491c-831e-3c248934c5bb":{"in":"query","name":"expand","schema":{"type":"string","description":"A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.","uniqueKey":"","typeLabel":"string"},"description":"A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.","example":"steps.action"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"See our Building a Zap guide to get started.","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"The ID of the Action to be associated with this step","isRequired":true,"uniqueKey":"data.steps.items.[INDEX].action","typeLabel":"string"},"inputs":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.steps.items.[INDEX].inputs.additionalProperties","typeLabel":"any"},"description":"The inputs for the Action associated with this step","isRequired":true,"uniqueKey":"data.steps.items.[INDEX].inputs","typeLabel":"object"},"authentication":{"oneOf":[{"type":"string","description":"The authentication, if required, for this Action to run","isRequired":true,"uniqueKey":"data.steps.items.[INDEX].authentication.oneOf.0","typeLabel":"string"},{"type":"null","description":"The authentication, if required, for this Action to run","isRequired":true,"uniqueKey":"data.steps.items.[INDEX].authentication.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.steps.items.[INDEX].authentication","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","description":"Optional alias for this step to be referenced by later steps (snake_case, max 64 chars)","maxLength":64,"pattern":"^[a-z][a-z0-9_]*$","uniqueKey":"data.steps.items.[INDEX].alias.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional alias for this step to be referenced by later steps (snake_case, max 64 chars)","maxLength":64,"pattern":"^[a-z][a-z0-9_]*$","uniqueKey":"data.steps.items.[INDEX].alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.steps.items.[INDEX].alias","typeLabel":"string | null"}},"required":["action","authentication","inputs"],"uniqueKey":"data.steps.items.[INDEX]","typeLabel":"object"},"description":"The list of steps that the Zap should consist of","isRequired":true,"uniqueKey":"data.steps","typeLabel":"object[]"},"title":{"type":"string","description":"The title to be set for this Zap","isRequired":true,"uniqueKey":"data.title","typeLabel":"string"}},"required":["steps","title"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"ToBeCreatedZap":{"title":"ToBeCreatedZap","value":{"data":{"steps":[{"action":"example_core:5m2y9p7J","inputs":{"code":"output = [{id: Math.round(Date.now()/1000), n: Math.random()}];"},"authentication":null,"alias":null},{"action":"example_core:VBz2NGB5","inputs":{"code":"output = [{ id: inputData.id, n: inputData.n * 2}];","inputs":{"n":"{{n}}","id":"{{id}}"}},"authentication":null,"alias":null}],"title":"My Critically Important Program"}}},"ManyStepZap":{"title":"ManyStepZap","value":{"data":{"steps":[{"action":"core:9QKqnTZ54VnrL2opYbkJJKveKEr2GJ","inputs":{},"authentication":"Vx4PEEeV","alias":"slack_new_saved_message"},{"action":"core:2oY5MSxlgML1jb43A0nroedgjdnVM","inputs":{"to":["chang.hsiao@irohalen.example"],"subject":"3 step zap - new message saved in slack","body":"Saved new message from:\n{{slack_new_saved_message.user__real_name}}\n\n\nMessage Content:\n{{text}}"},"authentication":"k0QBMMDK","alias":null},{"action":"core:vDakLS1PLO4J29eodDRLa5okErEn0","inputs":{"channel":"U036ZHWNHU2","text":"Saved new message from:\n{{slack_new_saved_message.user__real_name}}\n\n\nEmail thread id:\n{{threadId}}\n\n\nMessage Content:\n{{slack_new_saved_message.text}}"},"authentication":"Vx4PEEeV","alias":"slack_send_direct_message"}],"title":"My 3 step zap"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"f950b3c3-dc02-4032-a02c-80bc4edf071b":{"content":{"application/json":{"schema":{"type":"object","description":"A Zap is an automated workflow that connects your apps and services together.","properties":{"type":{"type":"string","readOnly":true,"description":"The type of this object.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"id":{"type":"string","readOnly":true,"description":"A unique identifier of the Zap.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"last_successful_run_date":{"oneOf":[{"type":"string","readOnly":true,"description":"The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.","isRequired":true,"uniqueKey":"last_successful_run_date.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.","isRequired":true,"uniqueKey":"last_successful_run_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_successful_run_date","typeLabel":"string | null"},"updated_at":{"type":"string","readOnly":true,"description":"The last time this Zap was updated","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string"},"title":{"type":"string","description":"The human readable name of the Zap.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"links":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"links.additionalProperties","typeLabel":"any"},"readOnly":true,"description":"Link to open this Zap in the Zapier Editor","isRequired":true,"uniqueKey":"links","typeLabel":"object"},"steps":{"description":"A list of the steps this Zap consists of","type":"array","items":{"oneOf":[{"type":"object","description":"An ordered list of steps that define the logic of the Zap.","required":["action","authentication","inputs","title"],"properties":{"action":{"oneOf":[{"type":"object","description":"Action","required":["action_type","app","description","id","is_instant","key","title","type"],"properties":{"id":{"type":"string","description":"The ID to refer to this action (unstable, may change when referenced app changes)","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.id","typeLabel":"string"},"key":{"type":"string","description":"The developer provided identifier for this Action (stable)","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.key","typeLabel":"string"},"app":{"oneOf":[{"type":"object","description":"Apps","required":["action_types","categories","description","hex_color","id","image","images","links","title"],"properties":{"id":{"type":"string","description":"Unique id of the app","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.id","typeLabel":"string"},"image":{"type":"string","description":"Default image/icon to represent the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.image","typeLabel":"string"},"links":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.links.additionalProperties","typeLabel":"any"},"description":"A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.\n\n If value is `null`, then no authentication is required to use the app. Client ID-authenticated requests will never have this object's fields populated.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.links","typeLabel":"object"},"action_types":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.action_types.items.[INDEX]","typeLabel":"any"},"description":"A list of action types for this specific App","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.action_types","typeLabel":"any[]"},"title":{"type":"string","description":"Human readable name of the app","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.title","typeLabel":"string"},"images":{"type":"object","description":"The URL of images (of various sizes) for this specific App","required":["url_128x128","url_16x16","url_32x32","url_64x64"],"properties":{"url_16x16":{"type":"string","description":"16x16 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.images.url_16x16","typeLabel":"string"},"url_32x32":{"type":"string","description":"32x32 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.images.url_32x32","typeLabel":"string"},"url_64x64":{"type":"string","description":"64x64 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.images.url_64x64","typeLabel":"string"},"url_128x128":{"type":"string","description":"128x128 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.images.url_128x128","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.images","typeLabel":"object"},"hex_color":{"type":"string","description":"A branded color that can be used to represent the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.hex_color","typeLabel":"string"},"categories":{"type":"array","items":{"type":"object","description":"Category an app belongs to.","properties":{"slug":{"type":"string","description":"The shortened slug name for this category","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.categories.items.[INDEX].slug","typeLabel":"string"}},"required":["slug"],"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.categories.items.[INDEX]","typeLabel":"object"},"description":"A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.categories","typeLabel":"object[]"},"description":{"type":"string","description":"Human readable description of the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.description","typeLabel":"string"},"key":{"oneOf":[{"type":"string","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.key.oneOf.0","typeLabel":"string"},{"type":"null","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.key","typeLabel":"string | null"},"selected_api":{"oneOf":[{"type":"string","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.selected_api.oneOf.0","typeLabel":"string"},{"type":"null","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.selected_api.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.selected_api","typeLabel":"string | null"},"type":{"type":"string","default":"app","description":"The type of this object.","uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.0","typeLabel":"object"},{"type":"string","description":"Apps","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.app","typeLabel":"object | string"},"type":{"type":"string","description":"The type of this object\n\n* `action` - action","enum":["action"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"action_type":{"type":"string","description":"The type of this Action\n\n* `READ` - READ\n* `READ_BULK` - READ_BULK\n* `WRITE` - WRITE\n* `SEARCH` - SEARCH\n* `SEARCH_OR_WRITE` - SEARCH_OR_WRITE\n* `SEARCH_AND_WRITE` - SEARCH_AND_WRITE\n* `FILTER` - FILTER","enum":["action"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.action_type","typeLabel":"enum\u003cstring>"},"is_instant":{"type":"boolean","description":"Will be set to `true` if this Action triggers instantly. May only be `true` when `type` is `READ`.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.is_instant","typeLabel":"boolean"},"title":{"type":"string","description":"The title of this Action.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.title","typeLabel":"string"},"description":{"type":"string","description":"A longer description of this Action, usually describing what it does in more detail.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0.description","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.0","typeLabel":"object"},{"type":"string","description":"Action","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.action","typeLabel":"object | string"},"authentication":{"oneOf":[{"type":"object","description":"Authentication","required":["app","id","is_expired","title","type"],"properties":{"type":{"type":"string","description":"The type of this object.\n\n* `authentication` - authentication","default":"authentication","enum":["authentication"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique UUID identifier for this specific Authentication. Legacy hashids are still accepted on input for backwards compatibility.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.id","typeLabel":"string"},"app":{"oneOf":[{"type":"object","description":"An app that integrates with Zapier.","required":["action_types","categories","description","hex_color","id","image","images","links","title"],"properties":{"id":{"type":"string","description":"Unique id of the app","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.id","typeLabel":"string"},"image":{"type":"string","description":"Default image/icon to represent the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.image","typeLabel":"string"},"links":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.links.additionalProperties","typeLabel":"any"},"description":"A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.\n\n If value is `null`, then no authentication is required to use the app. Client ID-authenticated requests will never have this object's fields populated.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.links","typeLabel":"object"},"action_types":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.action_types.items.[INDEX]","typeLabel":"any"},"description":"A list of action types for this specific App","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.action_types","typeLabel":"any[]"},"title":{"type":"string","description":"Human readable name of the app","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.title","typeLabel":"string"},"images":{"type":"object","description":"The URL of images (of various sizes) for this specific App","required":["url_128x128","url_16x16","url_32x32","url_64x64"],"properties":{"url_16x16":{"type":"string","description":"16x16 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.images.url_16x16","typeLabel":"string"},"url_32x32":{"type":"string","description":"32x32 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.images.url_32x32","typeLabel":"string"},"url_64x64":{"type":"string","description":"64x64 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.images.url_64x64","typeLabel":"string"},"url_128x128":{"type":"string","description":"128x128 resolution image URL","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.images.url_128x128","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.images","typeLabel":"object"},"hex_color":{"type":"string","description":"A branded color that can be used to represent the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.hex_color","typeLabel":"string"},"categories":{"type":"array","items":{"type":"object","description":"Category an app belongs to.","properties":{"slug":{"type":"string","description":"The shortened slug name for this category","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.categories.items.[INDEX].slug","typeLabel":"string"}},"required":["slug"],"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.categories.items.[INDEX]","typeLabel":"object"},"description":"A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.categories","typeLabel":"object[]"},"description":{"type":"string","description":"Human readable description of the app.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.description","typeLabel":"string"},"key":{"oneOf":[{"type":"string","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.key.oneOf.0","typeLabel":"string"},{"type":"null","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.key","typeLabel":"string | null"},"selected_api":{"oneOf":[{"type":"string","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.selected_api.oneOf.0","typeLabel":"string"},{"type":"null","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.selected_api.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.selected_api","typeLabel":"string | null"},"type":{"type":"string","default":"app","description":"The type of this object.","uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0.type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.0","typeLabel":"object"},{"type":"string","description":"An app that integrates with Zapier.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.app","typeLabel":"object | string"},"is_expired":{"type":"boolean","description":"If `true`, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.is_expired","typeLabel":"boolean"},"title":{"type":"string","description":"The title of this specific Authentication","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0.title","typeLabel":"string"}},"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.0","typeLabel":"object"},{"type":"string","description":"Authentication","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.1","typeLabel":"string"},{"type":"null","description":"Authentication","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.authentication","typeLabel":"object | string | null"},"inputs":{"readOnly":true,"description":"The inputs for this specific Zap's step","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.inputs","typeLabel":"any"},"title":{"oneOf":[{"type":"string","readOnly":true,"description":"The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.","isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"steps.items.[INDEX].oneOf.0.title","typeLabel":"string | null"}},"uniqueKey":"steps.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"string","uniqueKey":"steps.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"steps.items.[INDEX]","typeLabel":"object | string"},"isRequired":true,"uniqueKey":"steps","typeLabel":"(object | string)[]"},"is_enabled":{"type":"boolean","default":true,"description":"Whether the Zap is enabled (running) or not.","uniqueKey":"is_enabled","typeLabel":"boolean"}},"required":["id","last_successful_run_date","links","steps","title","type","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"CustomCreatedZap":{"title":"CustomCreatedZap","value":{"type":"zap","id":"033cc069f2d3-4d63-8666-10c07ab38dac","is_enabled":true,"last_successful_run_date":"2019-08-24T14:15:22Z","updated_at":"2024-03-14T22:02:36+00:00","title":"My Critically Important Program","links":{"html_editor":"https://zapier.com/editor/104826178?utm_source=partner\u0026utm_medium=embed\u0026utm_campaign=partner_api\u0026referer=zapier"},"steps":[{"action":"example_core:Vn7xbE60","authentication":"02ad1e61-17a9-87fa-971f-8619fb788562","inputs":{},"title":null},{"action":"example_core:V7GpzX40","authentication":null,"inputs":null,"title":null}]}}},"exampleType":"examples"}},"description":"","exampleType":"examples"},"e91c30b9-8ecd-44df-abba-04c970b029fa":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"MalformedRequest.":{"title":"MalformedRequest.","value":{"errors":[{"status":400,"code":"parse_error","title":"ParseError","detail":"Malformed request.","source":null,"meta":{"source":"ZAPIER","full_details":{"message":"Malformed request.","code":"parse_error"}}}]}}},"exampleType":"examples"}},"description":"This schema can be expected for 4xx 'Malformed request.' errors","exampleType":"examples"},"7d3a0d04-7cd8-4ac3-a0f5-6fbc566f230b":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"401 Response","exampleType":"generated"},"709f8f21-e8bf-4d62-b4bd-c86e06ed8871":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"403 Response","exampleType":"generated"},"2b05bab2-bc60-4ce0-ae1c-edd9e4352b1f":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"409 Response","exampleType":"generated"},"f1fcc8ea-e3a5-442b-a7f7-ea5096ec1324":{"headers":{"Retry-After":{"schema":{"type":"string","format":"uri"},"description":"Indicates when to retry the request"},"X-RateLimit-Limit":{"schema":{"type":"string","format":"uri"},"description":"The maximum number of requests you're permitted to make per hour."},"X-RateLimit-Remaining":{"schema":{"type":"string","format":"uri"},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"string","format":"uri"},"description":"The time at which the current rate limit window resets in UTC epoch seconds."}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"429 Response","exampleType":"generated"},"68a5e952-2365-41c0-b75c-7fb0a3be0b82":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"AServerErrorOccurred.":{"title":"AServerErrorOccurred.","value":{"errors":[{"status":500,"code":"error","title":"APIException","detail":"A server error occurred.","source":null,"meta":{"source":"ZAPIER","full_details":{"message":"A server error occurred.","code":"error"}}}]}}},"exampleType":"examples"}},"description":"This schema can be expected for 5xx 'A server error occurred.' errors","exampleType":"examples"},"0d3518a6-2635-4cdd-9233-5246ae7ab1cc":{"headers":{"Retry-After":{"schema":{"type":"string","format":"uri"},"description":"Indicates when to retry the request"},"X-RateLimit-Limit":{"schema":{"type":"string","format":"uri"},"description":"The maximum number of requests you're permitted to make per hour."},"X-RateLimit-Remaining":{"schema":{"type":"string","format":"uri"},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"string","format":"uri"},"description":"The time at which the current rate limit window resets in UTC epoch seconds."}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"503 Response","exampleType":"generated"},"5521ee07-d485-4fa8-9366-febca3087e2e":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","description":"Base Error definition","properties":{"status":{"type":"integer","description":"The HTTP status code applicable to this problem.","uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"code":{"type":"string","description":"A unique identifier for this particular occurrence of the problem.","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"A short summary of the problem.","uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"An object containing references to the primary source of the error.","properties":{"pointer":{"type":"string","description":"Pointer to the value in the request document that caused the error e.g. `/actions`.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.pointer","typeLabel":"string"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.parameter","typeLabel":"string"},"header":{"type":"string","description":"A string indicating the name of a single request header which caused the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.0.header","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing references to the primary source of the error.","uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object | null"},"meta":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].meta.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Freeform metadata about the error","uniqueKey":"errors.items.[INDEX].meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object | null"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"An array of error objects.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":123,"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>","header":"\u003cstring>"},"meta":{}}]}}},"exampleType":"generated"}},"description":"504 Response","exampleType":"generated"}},"security":{"49366cb4-de82-4b19-8015-611ca25e3fa3":{"OAuth":{"type":"oauth2","description":"See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication","flows":{"authorizationCode":{"authorizationUrl":"https://zapier.com/oauth/authorize/","tokenUrl":"https://zapier.com/oauth/token/","refreshUrl":"https://zapier.com/oauth/token/","scopes":{"profile":"Read profile information about the currently-authenticated user","zap":"Read Zaps","zap:write":"Write Zaps","authentication":"Read Authentications","authentication:write":"Write Authentications","zap:runs":"Read Zap Runs","action:run":"Run an Action","zap:all":"Read Zaps accessible to the account","connection:read":"Read Connections (Authentications)","connection:write":"Write Connections (Authentications)","connection:delete":"Delete Connections (Authentications)"}},"implicit":{"authorizationUrl":"https://zapier.com/oauth/authorize/","scopes":{"profile":"Read profile information about the currently-authenticated user","zap":"Read Zaps","zap:write":"Write Zaps","authentication":"Read Authentications","authentication:write":"Write Authentications","zap:runs":"Read Zap Runs","action:run":"Run an Action","zap:all":"Read Zaps accessible to the account","connection:read":"Read Connections (Authentications)","connection:write":"Write Connections (Authentications)","connection:delete":"Delete Connections (Authentications)"}}},"scopes":["zap:write","zap:all"],"schemeName":"OAuth"}}},"servers":{"754752ae-c9ce-43e6-9996-f70b087afa0e":{"url":"https://api.zapier.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication","flows":{"authorizationCode":{"authorizationUrl":"https://zapier.com/oauth/authorize/","tokenUrl":"https://zapier.com/oauth/token/","refreshUrl":"https://zapier.com/oauth/token/","scopes":{"profile":"Read profile information about the currently-authenticated user","zap":"Read Zaps","zap:write":"Write Zaps","authentication":"Read Authentications","authentication:write":"Write Authentications","zap:runs":"Read Zap Runs","action:run":"Run an Action","zap:all":"Read Zaps accessible to the account","connection:read":"Read Connections (Authentications)","connection:write":"Write Connections (Authentications)","connection:delete":"Delete Connections (Authentications)"}},"implicit":{"authorizationUrl":"https://zapier.com/oauth/authorize/","scopes":{"profile":"Read profile information about the currently-authenticated user","zap":"Read Zaps","zap:write":"Write Zaps","authentication":"Read Authentications","authentication:write":"Write Authentications","zap:runs":"Read Zap Runs","action:run":"Run an Action","zap:all":"Read Zaps accessible to the account","connection:read":"Read Connections (Authentications)","connection:write":"Write Connections (Authentications)","connection:delete":"Delete Connections (Authentications)"}}},"scopes":["zap:write","zap:all"],"schemeName":"OAuth"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth","name":"Authorization"}],"title":"OAuth"}]},"originalFileLocation":"https://api.zapier.com/schema"},"subdomain":"zapier-82f0e938","siteName":"Zapier","title":"Create a Zap - Zapier","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/workflow/zaps/create-a-zap.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=\"This URL creates a Zap based on the given steps and title. #### When using OAuth This endpoint requires the zap:write, or zap:all OAuth scopes.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zapier\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Zap - Zapier\">\u003cmeta data-mint-head property=\"og:description\" content=\"This URL creates a Zap based on the given steps and title. #### When using OAuth This endpoint requires the zap:write, or zap:all OAuth scopes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zapier\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zapier-82f0e938.mintlify.app/_mintlify/api/og/v2?division=Zaps\u0026amp;title=Create+a+Zap\u0026amp;description=This+URL+creates+a+Zap+based+on+the+given+steps+and+title.%0A%0A%23%23%23%23+When+using+OAuth%0A%0AThis+endpoint+requires+the+%60zap%3Awrite%60%2C+or+%60zap%3Aall%60+OAuth+scopes.\u0026amp;theme=d7e460cb9cc5ba95e728a619\u0026amp;signature=3740e4a5d77da624651a64e9ea701574ac49a491481c080c816d157ac4dd94fe\">\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=\"Create a Zap - Zapier\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This URL creates a Zap based on the given steps and title. #### When using OAuth This endpoint requires the zap:write, or zap:all OAuth scopes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zapier-82f0e938.mintlify.app/_mintlify/api/og/v2?division=Zaps\u0026amp;title=Create+a+Zap\u0026amp;description=This+URL+creates+a+Zap+based+on+the+given+steps+and+title.%0A%0A%23%23%23%23+When+using+OAuth%0A%0AThis+endpoint+requires+the+%60zap%3Awrite%60%2C+or+%60zap%3Aall%60+OAuth+scopes.\u0026amp;theme=d7e460cb9cc5ba95e728a619\u0026amp;signature=3740e4a5d77da624651a64e9ea701574ac49a491481c080c816d157ac4dd94fe\">\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/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zapier\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4F00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workflow/zaps/create-a-zap.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zapier.com/#organization\",\"name\":\"Zapier\",\"url\":\"https://docs.zapier.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zapier-82f0e938/uPbDC0jSuXgHCaWD/logo/light.svg?fit=max\u0026auto=format\u0026n=uPbDC0jSuXgHCaWD\u0026q=85\u0026s=b6a37289cb22ac1a9681572651874765\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zapier.com#website\",\"name\":\"Zapier\",\"url\":\"https://docs.zapier.com\",\"publisher\":{\"@id\":\"https://docs.zapier.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap#webpage\",\"url\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap\",\"name\":\"Create a Zap\",\"description\":\"This URL creates a Zap based on the given steps and title. #### When using OAuth This endpoint requires the zap:write, or zap:all OAuth scopes.\",\"isPartOf\":{\"@id\":\"https://docs.zapier.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflow API\",\"item\":\"https://docs.zapier.com/api-reference/workflow/apps/get-apps-v1\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Zaps\",\"item\":\"https://docs.zapier.com/api-reference/workflow/zaps/get-zaps-v1\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a Zap\",\"item\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap#apireference\",\"headline\":\"Create a Zap\",\"name\":\"Create a Zap\",\"description\":\"This URL creates a Zap based on the given steps and title. #### When using OAuth This endpoint requires the zap:write, or zap:all OAuth scopes.\",\"url\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zapier.com/api-reference/workflow/zaps/create-a-zap#webpage\"},\"publisher\":{\"@id\":\"https://docs.zapier.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zapier.com#website\"}}]}\u003c/script>","siteName":"Zapier","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://community.zapier.com/"},{"anchor":"Changelog","icon":"rss","href":"/white-label/changelog"},{"anchor":"Contact Us","icon":"envelope","href":"https://developer.zapier.com/contact"}]},"tabs":[{"tab":"Home","hidden":true,"searchable":true,"pages":[{"title":"Home","href":""}]},{"tab":"Use Zapier in your tools","menu":[{"item":"Install Zapier","description":"Gets you to a first action. Zapier MCP by default, with the SDK and CLI as alternatives.","pages":[{"title":"Install Zapier","href":"/install"}]},{"item":"Zapier MCP","description":"Connect from inside your AI client. Your agent runs actions across 9,000+ apps.","pages":[{"title":"Zapier MCP","href":"/mcp/home"}]},{"item":"Zapier SDK","description":"TypeScript for code projects, with OAuth and retries handled. Open beta.","pages":[{"title":"Zapier SDK","href":"/sdk"}]},{"item":"Proxy API","description":"Make authenticated HTTP requests to any app API through Zapier.","pages":[{"title":"Proxy API","href":"/proxy-api/overview"}]},{"item":"Zapier Connectors","description":"Ready-made toolkits your agent can use, one per app. Prototype.","pages":[{"title":"Zapier Connectors","href":"/connectors/overview"}]}],"pages":[{"title":"Use Zapier in your tools","href":"/install"}]},{"tab":"Build a Zapier integration","menu":[{"item":"Developer Platform","description":"Build a private integration for your own team, or a public one for the App Directory.","pages":[{"title":"Developer Platform","href":"/integrations"}]}],"pages":[{"title":"Build a Zapier integration","href":"/integrations"}]},{"tab":"Embed Zapier","menu":[{"item":"Powered by Zapier","description":"Embed Zapier. Users pay Zapier directly.","pages":[{"title":"Powered by Zapier","href":"/powered-by-zapier"}]},{"item":"White Label","description":"Native automation. No user Zapier account; your product pays Zapier.","pages":[{"title":"White Label","href":"/white-label/getting-started"}]}],"pages":[{"title":"Embed Zapier","href":"/powered-by-zapier"}]},{"tab":"API reference","groups":[{"group":" ","pages":[{"title":"Zapier API reference: OpenAPI specs, endpoints, and schemas","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"Trigger Inbox API","pages":[{"group":"Inboxes","pages":[{"title":"List all inboxes","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/list-all-inboxes"},{"title":"Ensure an inbox exists","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml put /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/ensure-an-inbox-exists"},{"title":"Create an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/create-an-inbox"},{"title":"Get inbox details","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/get-inbox-details"},{"title":"Mark an inbox for deletion","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml delete /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/mark-an-inbox-for-deletion"},{"title":"Update inbox settings","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml patch /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/update-inbox-settings"},{"title":"Pause an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{id}/pause","href":"/api-reference/trigger-inbox/inboxes/pause-an-inbox"},{"title":"Resume an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{id}/resume","href":"/api-reference/trigger-inbox/inboxes/resume-an-inbox"},{"title":"Subscribe to inbox notifications over SSE","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{inbox_id}/events","href":"/api-reference/trigger-inbox/inboxes/subscribe-to-inbox-notifications-over-sse"}]},{"group":"Inbox Messages","pages":[{"title":"List messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{inbox_id}/messages","href":"/api-reference/trigger-inbox/inbox-messages/list-messages-from-an-inbox"},{"title":"Lease messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/lease","href":"/api-reference/trigger-inbox/inbox-messages/lease-messages-from-an-inbox"},{"title":"Acknowledge messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/ack","href":"/api-reference/trigger-inbox/inbox-messages/acknowledge-messages-from-an-inbox"},{"title":"Release leased messages without acknowledging","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/release","href":"/api-reference/trigger-inbox/inbox-messages/release-leased-messages-without-acknowledging"}]},{"group":"API Reference","pages":[{"title":"Message availability notification","version":null,"deprecated":null,"openapi":"/api-reference/specs/trigger-inbox.yaml webhook messageAvailable","href":"/api-reference/trigger-inbox/message-availability-notification"}]}]},{"group":"Actions API","pages":[{"group":"Stored Actions","pages":[{"title":"List stored actions","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions","href":"/api-reference/actions/stored-actions/list-stored-actions"},{"title":"Create a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml post /actions/v1/stored-actions","href":"/api-reference/actions/stored-actions/create-a-stored-action"},{"title":"Get a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/get-a-stored-action"},{"title":"Delete a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml delete /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/delete-a-stored-action"},{"title":"Update a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml patch /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/update-a-stored-action"},{"title":"Run a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml post /actions/v1/stored-actions/{stored_action_id}/run","href":"/api-reference/actions/stored-actions/run-a-stored-action"},{"title":"Get stored action run results","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}/runs/{run_id}","href":"/api-reference/actions/stored-actions/get-stored-action-run-results"}]}]},{"group":"Workflow API","pages":[{"group":"Apps","pages":[{"title":"Get Apps v1","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/apps","href":"/api-reference/workflow/apps/get-apps-v1"},{"title":"Get Apps v2","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/apps","href":"/api-reference/workflow/apps/get-apps-v2"},{"title":"Get Whitelabel Apps v2","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/whitelabel/apps","href":"/api-reference/workflow/apps/get-whitelabel-apps-v2"}]},{"group":"Categories","pages":[{"title":"Get Categories","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/categories","href":"/api-reference/workflow/categories/get-categories"}]},{"group":"Accounts","pages":[{"title":"User Profile","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/profiles/me","href":"/api-reference/workflow/accounts/user-profile"},{"title":"Create Account","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/authorize","href":"/api-reference/workflow/accounts/create-account"}]},{"group":"Zap Templates","pages":[{"title":"Get Zap Templates","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/zap-templates","href":"/api-reference/workflow/zap-templates/get-zap-templates"}]},{"group":"Zaps","pages":[{"title":"Get Zaps v1","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/zaps","href":"/api-reference/workflow/zaps/get-zaps-v1"},{"title":"Guess a Zap Beta","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/guess","href":"/api-reference/workflow/zaps/guess-a-zap-beta"},{"title":"Get Zaps v2","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\nThe `expand` array can be used to expand selected fields into full objects in the response. Inputs with keys can\nalso be passed to filter Zaps by certain criteria.\n\n**Scope Selection:**\n- Use `zap` if you have a Zapier integration and wish to get only Zaps using your integration.\n- Use `zap:all` to get all of the user's Zaps.\n- Use `zap:account:all` to get all of the Zaps the user has access to in their account.\n\n#### When using OAuth\n\nThis endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scopes.","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/zaps","href":"/api-reference/workflow/zaps/get-zaps-v2"},{"title":"Create a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps","href":"/api-reference/workflow/zaps/create-a-zap"},{"title":"Delete a Zap","description":"Permanently deletes a Zap on behalf of an end user. The Zap is stopped and removed from the end user's account. This action cannot be undone.\n\n#### When using OAuth\n\nThis endpoint requires the `zap:delete` OAuth scope.","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema delete /v2/zaps/{id}","href":"/api-reference/workflow/zaps/delete-a-zap"},{"title":"Edit a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema patch /v2/zaps/{id}","href":"/api-reference/workflow/zaps/edit-a-zap"},{"title":"Disable a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/disable","href":"/api-reference/workflow/zaps/disable-a-zap"},{"title":"Enable a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/enable","href":"/api-reference/workflow/zaps/enable-a-zap"}]},{"group":"Actions","pages":[{"title":"Create an Action Run","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/action-runs","href":"/api-reference/workflow/actions/create-an-action-run"},{"title":"Retrieve Action Run","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/action-runs/{id}","href":"/api-reference/workflow/actions/retrieve-action-run"},{"title":"Get Actions","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/actions","href":"/api-reference/workflow/actions/get-actions"},{"title":"Get Input Fields","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs","href":"/api-reference/workflow/actions/get-input-fields"},{"title":"Get Choices","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/api-reference/workflow/actions/get-choices"},{"title":"Get Output Fields","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/outputs","href":"/api-reference/workflow/actions/get-output-fields"},{"title":"Step Test","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/test","href":"/api-reference/workflow/actions/step-test"}]},{"group":"Authentications","pages":[{"title":"Get Authentications","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/authentications","href":"/api-reference/workflow/authentications/get-authentications"},{"title":"Create Authentication","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/authentications","href":"/api-reference/workflow/authentications/create-authentication"},{"title":"Delete Authentication","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema delete /v2/authentications/{authentication_id}","href":"/api-reference/workflow/authentications/delete-authentication"}]},{"group":"Experimental","pages":[{"title":"Get Zap Runs","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/zap-runs","href":"/api-reference/workflow/experimental/get-zap-runs"}]}]},{"group":"Connections API","pages":[{"group":"Connection Webhooks","pages":[{"title":"List connection webhooks","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml get /connections/v1/webhooks","href":"/api-reference/connections/connection-webhooks/list-connection-webhooks"},{"title":"Create a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml post /connections/v1/webhooks","href":"/api-reference/connections/connection-webhooks/create-a-connection-webhook"},{"title":"Retrieve a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml get /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/retrieve-a-connection-webhook"},{"title":"Delete a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml delete /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/delete-a-connection-webhook"},{"title":"Update a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml patch /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/update-a-connection-webhook"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml post /connections/v1/webhooks/{id}/test","href":"/api-reference/connections/connection-webhooks/send-a-test-delivery"}]}]},{"group":"Agentic Management","pages":[{"group":"Automations","pages":[{"title":"Enable Agentic Management for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml post /agentic-management/v0/","href":"/api-reference/agentic-management/automations/enable-agentic-management-for-a-workflow"},{"title":"Get Agentic Management config for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml get /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/get-agentic-management-config-for-a-workflow"},{"title":"Disable Agentic Management for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml delete /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/disable-agentic-management-for-a-workflow"},{"title":"Update Agentic Management config for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml patch /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/update-agentic-management-config-for-a-workflow"},{"title":"Get the declared intent for a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml get /agentic-management/v0/{workflow_id}/intent","href":"/api-reference/agentic-management/automations/get-the-declared-intent-for-a-workflow-version"},{"title":"Create or update the declared intent for a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml put /agentic-management/v0/{workflow_id}/intent","href":"/api-reference/agentic-management/automations/create-or-update-the-declared-intent-for-a-workflow-version"}]}]}]}]},"title":"Create a Zap - Zapier","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}