Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan’s limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key’s drafts name the key’s creator.
An API key (utk_live_...) or an app's OAuth access token (uto_...).
Headers
Idempotency-Key
string
Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.
Maximum string length: 255
Body
application/json
Any other field is 400 PUB-008-001.
name
string
required
Required string length: 1 - 255
channel
enum<string>
website (default) or link; email is 400 PUB-008-009.
Available options:
website,
link
defaultLanguage
string
A language the organization offers (default en).
Example:
"en"
languages
string[]
Every language the survey is written in, within the plan; the default language is always one.
displayMode
enum<string>
steps (default), all or chat.
Available options:
steps,
all,
chat
position
enum<string>
Available options:
bottom-right,
bottom-left,
top-right,
top-left,
center-modal
texts
object
The widget's words by key (title, subtitle, submitButton, prevButton, nextButton, startButton, closeButton, successTitle, successMessage, errorMessage, requiredField, redirectNote, minimizedText, launcherLabel); null removes one.
Show child attributes
siteId
string<uuid>
website: the site to run on (GET /sites); without it, the oldest site.
targeting
object
The targeting every plan runs. Only the parts sent change; any other field is 400 PUB-008-001.
Show child attributes
questions
object[]
Maximum array length: 200
Show child attributes
Response
Created.
id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
paused,
archived
channel
enum<string>
required
Available options:
website,
link,
email
site
object | null
required
Show child attributes
draftVersion
integer
required
Send it back as expectedDraftVersion.
editable
boolean
required
True only for a survey in draft status: the API edits nothing else.
editorUrl
string<uri>
required
The survey in the Usertick editor, where a person publishes it. Give it to the person.
defaultLanguage
string
required
languages
string[]
required
displayMode
enum<string>
required
Available options:
steps,
all,
chat
position
string
required
texts
object
required
Show child attributes
targeting
object
required
Show child attributes
questions
object[]
required
Show child attributes
publishChecks
object[]
required
What publishing would refuse now: a report for the person who publishes. Nothing here blocks saving a draft.
Show child attributes
createdAt
string<date-time>
required
Example:
"2026-09-30T10:00:00.000Z"
updatedAt
string<date-time>
required
Example:
"2026-09-30T10:00:00.000Z"
aiGenerated
boolean
required
True when Usertick AI wrote text in the survey's own fields; each question has its own. Read only.
aiGeneratedAt
string<date-time> | null
required
When text Usertick AI wrote was first stored here; null when people wrote all of it.
Example:
"2026-09-30T10:00:00.000Z"
Last modified on November 8, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Usertick","description":"Usertick documentation. Surveys, in-product feedback and reporting in one tool.","colors":{"primary":"#FF3C00","light":"#FF6A3A","dark":"#FF3C00"},"logo":{"light":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/light.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=9461af4bcd4a352017accf4accb120f9","dark":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/dark.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=38efcf251321688f80e92485435ec4cc"},"favicon":"https://mintcdn.com/usertick/Viv5pff-I3XvBVsI/favicon.svg?fit=max\u0026auto=format\u0026n=Viv5pff-I3XvBVsI\u0026q=85\u0026s=22114aee3fd94be42445bda4f6eac751","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://app.usertick.com/api/public/v1"}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"/account/support","label":"Support"}],"primary":{"type":"button","label":"Open dashboard","href":"https://app.usertick.com"}},"footer":{"socials":{"website":"https://usertick.com","linkedin":"https://www.linkedin.com/company/usertick","x":"https://x.com/Usertick_ltd"},"links":[{"header":"Product","items":[{"label":"usertick.com","href":"https://usertick.com"},{"label":"Pricing","href":"https://usertick.com/pricing"},{"label":"Security","href":"https://usertick.com/security"},{"label":"Status","href":"https://status.usertick.com"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Install Usertick","href":"/installation"},{"label":"REST API","href":"/developers/api/overview"},{"label":"llms.txt","href":"/llms.txt"}]},{"header":"Help","items":[{"label":"Support","href":"/account/support"},{"label":"Troubleshooting","href":"/installation/troubleshooting"},{"label":"Contact","href":"https://usertick.com/contact"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://usertick.com/privacy"},{"label":"Terms","href":"https://usertick.com/terms"},{"label":"Cookies","href":"https://usertick.com/cookies"},{"label":"Subprocessors","href":"https://usertick.com/subprocessors"}]}]},"search":{"prompt":"Search the documentation"},"seo":{"organization":{"name":"Usertick","legalName":"Usertick Ltd","url":"https://usertick.com","logo":"https://cdn.usertick.com/brand/Usertick-o-icon.png","sameAs":["https://www.linkedin.com/company/usertick","https://x.com/Usertick_ltd"]}},"fonts":{"heading":{"family":"Schibsted Grotesk","weight":600,"source":"fonts/SchibstedGroteskVariable.woff2","format":"woff2"},"body":{"family":"Inter","weight":400,"source":"fonts/InterVariable.woff2","format":"woff2"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"errors":{"404":{"redirect":false,"title":"This page doesn't exist","description":"The page may have moved. Search the documentation, or start from [Install Usertick](/installation) or the [home page](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"thumbnails":{"surface":"brand","eyebrow":{"source":"group"}},"metadata":{"timestamp":true},"markdown":{"instructions":"Usertick runs surveys on websites, by link, by QR code and by email, and collects every response in one inbox with reports, dashboards and workflows. The REST API lives at https://app.usertick.com/api/public/v1 and uses Bearer API keys or OAuth access tokens; the JavaScript SDK is the @usertick/snippet package on npm."},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"usertick","hasAudioNarration":false,"actualSubdomain":"usertick","customDomains":["docs.usertick.com"],"gitSource":{"type":"github","owner":"usertick","repo":"docs","deployBranch":"main","contentDirectory":"public","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afcd3daa70ca500331bbe70","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Developers","count":108},{"language":"default","tag":"API reference","count":82},{"language":"default","tag":"Surveys","count":28},{"language":"default","tag":"Workflows","count":21},{"language":"default","tag":"REST API","count":19},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Results","count":16},{"language":"default","tag":"Settings","count":15},{"language":"default","tag":"Build surveys","count":12},{"language":"default","tag":"Guides","count":11}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Inter\";src:url(\"/fonts/InterVariable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:\"Schibsted Grotesk\";src:url(\"/fonts/SchibstedGroteskVariable.woff2\") format(\"woff2\");font-weight:400 900;font-style:normal;font-display:swap}.ut-hub{--ut-text: #171717;--ut-text-2: #404040;--ut-muted: #525252;--ut-border: #e5e5e5;--ut-band: #fafafa;--ut-surface: #ffffff;--ut-brand: #ff3c00;font-family:var(--font-family-body-custom, \"Inter\"), -apple-system, \"Segoe UI\", sans-serif;color:var(--ut-text)}html.dark .ut-hub{--ut-text: #fafafa;--ut-text-2: #d4d4d4;--ut-muted: #a3a3a3;--ut-border: rgba(255, 255, 255, 0.12);--ut-band: rgba(255, 255, 255, 0.03);--ut-surface: rgba(255, 255, 255, 0.02);--ut-brand: #ff6a3a}.ut-hub a{text-decoration:none;border-bottom:0}.ut-hub .ut-display{font-family:var(--font-family-headings-custom, \"Schibsted Grotesk\"), -apple-system, \"Segoe UI\", sans-serif;font-weight:600;letter-spacing:-0.015em;color:var(--ut-text);margin:0}.ut-hero{background:var(--ut-band);border-bottom:1px solid var(--ut-border)}.ut-hero-inner{max-width:48rem;margin:0 auto;padding:4.5rem 1rem 4rem;display:flex;flex-direction:column;align-items:center;gap:1.25rem;text-align:center}.ut-hub .ut-hero-title{font-size:3rem;line-height:1.1}.ut-hero-text{margin:0;font-size:1.125rem;line-height:1.6;color:var(--ut-muted)}.ut-search{width:100%;display:flex;align-items:center;gap:0.75rem;padding:0.875rem 1rem;border:1px solid #d4d4d4;border-radius:0.75rem;background:var(--ut-surface);color:var(--ut-muted);font:inherit;font-size:1rem;text-align:left;cursor:pointer;box-shadow:0 1px 2px rgba(10, 10, 10, 0.05)}html.dark .ut-search{border-color:rgba(255, 255, 255, 0.15);background:rgba(255, 255, 255, 0.05)}.ut-search:hover{border-color:#a3a3a3}.ut-search-label{flex:1}.ut-kbd{font-size:0.75rem;border:1px solid var(--ut-border);border-radius:0.25rem;padding:0.0625rem 0.375rem}.ut-popular{display:flex;flex-wrap:wrap;justify-content:center;gap:0.5rem 1rem;font-size:0.875rem;color:var(--ut-muted)}.ut-hub .ut-popular-link{color:var(--ut-text-2);text-decoration:underline;text-decoration-color:var(--ut-border);text-underline-offset:4px}.ut-body{max-width:80rem;margin:0 auto;padding:3.5rem 1.5rem 5rem;display:flex;flex-direction:column;gap:4rem}.ut-section{display:flex;flex-direction:column;gap:1.25rem}.ut-section-head{display:flex;flex-wrap:wrap;align-items:baseline;justify-content:space-between;gap:1rem}.ut-hub .ut-section-title{font-size:1.5rem}.ut-muted{font-size:0.875rem;color:var(--ut-muted)}.ut-start{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:1.25rem}.ut-hub .ut-card{display:flex;flex-direction:column;gap:0.75rem;padding:1.5rem;border:1px solid var(--ut-border);border-radius:0.75rem;background:var(--ut-surface)}.ut-hub .ut-card:hover{border-color:#a3a3a3}.ut-card-step{font-size:0.875rem;font-weight:600;color:var(--ut-brand)}.ut-hub .ut-card-title{font-size:1.25rem}.ut-card-text{font-size:0.9375rem;line-height:1.6;color:var(--ut-muted)}.ut-areas{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:2.5rem 2rem}.ut-area{display:flex;flex-direction:column;gap:0.625rem;padding-top:1rem;border-top:1px solid var(--ut-border)}.ut-hub .ut-area-title{font-size:1.0625rem;font-weight:600;color:var(--ut-text)}.ut-area-text{font-size:0.875rem;line-height:1.5;color:var(--ut-muted)}.ut-hub .ut-area-link{font-size:0.875rem;color:var(--ut-text-2)}.ut-hub .ut-area-more{font-size:0.875rem;font-weight:500;color:var(--ut-brand)}.ut-hub .ut-area-title:hover,.ut-hub .ut-area-link:hover,.ut-hub .ut-popular-link:hover{color:var(--ut-brand)}.ut-guides{display:flex;flex-direction:column;border:1px solid var(--ut-border);border-radius:0.75rem;overflow:hidden}.ut-hub .ut-guide{display:flex;flex-wrap:wrap;align-items:center;gap:1rem;padding:1rem 1.25rem;border-bottom:1px solid var(--ut-border)}.ut-hub .ut-guide:last-child{border-bottom:0}.ut-hub .ut-guide:hover{background:var(--ut-band)}.ut-guide-title{flex:1 1 16rem;font-size:0.9375rem;font-weight:500;color:var(--ut-text)}.ut-guide-meta,.ut-guide-time{font-size:0.8125rem;color:var(--ut-muted)}.ut-guide-time{min-width:4rem;text-align:right}.ut-dev{display:flex;flex-wrap:wrap;align-items:center;gap:2rem;padding:2.5rem;border-radius:1rem;background:#0a0a0a;color:#f5f5f5}html.dark .ut-dev{border:1px solid rgba(255, 255, 255, 0.12)}.ut-dev-text{flex:1 1 22rem;display:flex;flex-direction:column;gap:0.75rem}.ut-hub .ut-dev-title{font-size:1.5rem;color:#ffffff}.ut-dev-lead{margin:0;font-size:0.9375rem;line-height:1.6;color:#d4d4d4}.ut-dev-links{display:flex;flex-wrap:wrap;gap:0.5rem 1.25rem;font-size:0.875rem}.ut-hub .ut-dev-link{color:#ffffff;text-decoration:underline;text-decoration-color:rgba(255, 255, 255, 0.4);text-underline-offset:4px}.ut-hub .ut-dev-link:hover{text-decoration-color:#ffffff}.ut-dev-code{flex:1 1 26rem;min-width:0;margin:0;padding:1.25rem;overflow-x:auto;border:1px solid #404040;border-radius:0.75rem;background:#171717;color:#e5e5e5;font-family:ui-monospace, \"Roboto Mono\", Menlo, Consolas, monospace;font-size:0.8125rem;line-height:1.7}.ut-search svg{color:var(--ut-muted);background-color:var(--ut-muted)}.ut-foot{display:flex;flex-wrap:wrap;align-items:center;justify-content:space-between;gap:1rem;padding-top:2rem;border-top:1px solid var(--ut-border);font-size:0.875rem;color:var(--ut-muted)}.ut-foot-links{display:flex;flex-wrap:wrap;gap:0.5rem 1.25rem}@media (max-width: 1024px){.ut-areas{grid-template-columns:repeat(2, minmax(0, 1fr))}}@media (max-width: 768px){.ut-hub .ut-hero-title{font-size:2.25rem}.ut-hero-inner{padding-top:3rem}.ut-start,.ut-areas{grid-template-columns:minmax(0, 1fr)}.ut-body{padding:2.5rem 1rem 4rem}.ut-dev{padding:1.5rem}.ut-kbd{display:none}}"}],"page":{"pagePath":"developers/api/reference/create-survey","slug":"/developers/api/reference/create-survey","pageMetadata":{"title":"Create a survey draft","openapi":"api-reference/openapi.json POST /surveys","description":"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan's limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key's drafts name the key's creator.\n\nScopes: surveys:draft, surveys:read.","href":"/developers/api/reference/create-survey"},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan’s limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key’s drafts name the key’s creator.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Scopes: surveys:draft, surveys:read.\"\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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Create a survey draft","openapi":"api-reference/openapi.json POST /surveys","description":"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan's limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key's drafts name the key's creator.\n\nScopes: surveys:draft, surveys:read.","href":"/developers/api/reference/create-survey"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/usertick/6ca3f62bc5ac8ede/install-platform.js"],"openApiReferenceData":{"operation":{"operationId":"createSurvey","summary":"Create a survey draft","description":"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan's limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key's drafts name the key's creator.\n\nScopes: surveys:draft, surveys:read.","tags":["Surveys"],"x-scopes":["surveys:draft","surveys:read"],"parameters":["5d875543-ad64-46eb-adb1-2cd1de9f1f83"],"requestBody":"e07c3d7e-07e0-4af1-8a1d-b52caa562a6b","responses":{"201":"d7b696fd-ebdd-410a-b3ec-99dc4541e40b","400":"fe7c7207-3e74-473e-a6bf-984cebf6f13a","401":"1e4fe05c-94c1-48bd-8e23-8722164f82a6","403":"b00fc31b-018a-4b48-93dc-0e8fb6cf2b5e","404":"2d667ebf-2517-4c96-aa2c-f2524f87aefb","409":"c2f3fbad-ac9e-4438-a5ff-dd5284437c43","413":"68652d8b-c586-4b6e-9d8c-1085e1b349d2","415":"1f305404-6fe7-4204-a260-30a374ba4c5e","429":"77000033-fc15-4d5b-b472-b12caf1f0f20"},"method":"post","type":"path","servers":["a7da5109-6827-4042-ac09-900ca098b7bc"],"security":["e6f2970d-e0b1-4f31-89d6-ce42413df7c4","c628e213-b100-46e6-8ac3-7d3b1e7a9ebb"],"path":"/surveys","baseUrlOptions":["https://app.usertick.com/api/public/v1"],"title":"Create a survey draft","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5d875543-ad64-46eb-adb1-2cd1de9f1f83":{"name":"Idempotency-Key","in":"header","description":"Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.","required":false,"schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"channel":{"type":"string","description":"website (default) or link; email is 400 PUB-008-009.","enum":["website","link"],"uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"defaultLanguage":{"type":"string","description":"A language the organization offers (default en).","examples":["en"],"uniqueKey":"defaultLanguage","typeLabel":"string"},"languages":{"type":"array","items":{"type":"string","uniqueKey":"languages.items.[INDEX]","typeLabel":"string"},"description":"Every language the survey is written in, within the plan; the default language is always one.","uniqueKey":"languages","typeLabel":"string[]"},"displayMode":{"type":"string","description":"steps (default), all or chat.","enum":["steps","all","chat"],"uniqueKey":"displayMode","typeLabel":"enum\u003cstring>"},"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left","center-modal"],"uniqueKey":"position","typeLabel":"enum\u003cstring>"},"texts":{"type":"object","description":"The widget's words by key (title, subtitle, submitButton, prevButton, nextButton, startButton, closeButton, successTitle, successMessage, errorMessage, requiredField, redirectNote, minimizedText, launcherLabel); null removes one.","additionalProperties":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"texts.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"texts.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"null","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"texts.additionalProperties.oneOf.2","typeLabel":"null"}],"uniqueKey":"texts.additionalProperties","typeLabel":"string | object | null"},"uniqueKey":"texts","typeLabel":"object"},"siteId":{"type":"string","description":"website: the site to run on (GET /sites); without it, the oldest site.","format":"uuid","uniqueKey":"siteId","typeLabel":"string\u003cuuid>"},"targeting":{"type":"object","properties":{"pages":{"oneOf":[{"type":"object","description":"website: the pages to show on and to leave out; null shows it on every page. Replaces the page rules.","required":[],"properties":{"target":{"type":"string","description":"What every rule tests: the path, or the url with its query and hash.","enum":["path","url"],"uniqueKey":"targeting.pages.oneOf.0.target","typeLabel":"enum\u003cstring>"},"include":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["contains","equals","starts_with","ends_with","regex"],"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].value","typeLabel":"string"},"target":{"type":"string","description":"The same as pages.target; rules that name two are refused.","enum":["path","url"],"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"required":["op","value"],"additionalProperties":false,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"targeting.pages.oneOf.0.include","typeLabel":"object[]"},"exclude":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["contains","equals","starts_with","ends_with","regex"],"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].value","typeLabel":"string"},"target":{"type":"string","enum":["path","url"],"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"required":["op","value"],"additionalProperties":false,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"targeting.pages.oneOf.0.exclude","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"targeting.pages.oneOf.0","typeLabel":"object"},{"type":"null","description":"website: the pages to show on and to leave out; null shows it on every page. Replaces the page rules.","uniqueKey":"targeting.pages.oneOf.1","typeLabel":"null"}],"uniqueKey":"targeting.pages","typeLabel":"object | null"},"trigger":{"oneOf":[{"type":"object","description":"website: the one trigger; null leaves none (publishing asks for one).","required":["type"],"properties":{"type":{"type":"string","enum":["load","delay","scroll","exit_intent","time_on_site"],"isRequired":true,"uniqueKey":"targeting.trigger.oneOf.0.type","typeLabel":"enum\u003cstring>"},"seconds":{"type":"integer","description":"delay 0 to 60 (default 10), time_on_site 10 to 1800 (default 60).","uniqueKey":"targeting.trigger.oneOf.0.seconds","typeLabel":"integer"},"percent":{"type":"integer","description":"scroll 10 to 100 (default 50).","uniqueKey":"targeting.trigger.oneOf.0.percent","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"targeting.trigger.oneOf.0","typeLabel":"object"},{"type":"null","description":"website: the one trigger; null leaves none (publishing asks for one).","uniqueKey":"targeting.trigger.oneOf.1","typeLabel":"null"}],"uniqueKey":"targeting.trigger","typeLabel":"object | null"},"devices":{"type":"array","items":{"type":"string","enum":["desktop","tablet","mobile"],"uniqueKey":"targeting.devices.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The devices it shows on.","minItems":1,"uniqueKey":"targeting.devices","typeLabel":"enum\u003cstring>[]"},"frequency":{"type":"object","properties":{"type":{"type":"string","enum":["once","until_response","cooldown","always"],"uniqueKey":"targeting.frequency.type","typeLabel":"enum\u003cstring>"},"cooldownDays":{"type":"integer","minimum":0,"maximum":3650,"uniqueKey":"targeting.frequency.cooldownDays","typeLabel":"integer"},"maxDisplays":{"type":"integer","minimum":0,"maximum":1000,"uniqueKey":"targeting.frequency.maxDisplays","typeLabel":"integer"},"afterDismissDays":{"type":"integer","minimum":0,"maximum":3650,"uniqueKey":"targeting.frequency.afterDismissDays","typeLabel":"integer"}},"required":[],"description":"website: how often a visitor sees it, merged into what the survey has.","additionalProperties":false,"uniqueKey":"targeting.frequency","typeLabel":"object"}},"required":[],"description":"The targeting every plan runs. Only the parts sent change; any other field is 400 PUB-008-001.","additionalProperties":false,"uniqueKey":"targeting","typeLabel":"object"},"questions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"File upload, screenshot and signature questions are added in the dashboard (400 PUB-008-006). A type never changes.","enum":["welcome","nps","rating","ces","emoji","boolean","multiple_choice","dropdown","ranking","slider","text","contact","date","matrix","number","big_scale","ruler","dial","this_or_that","allocation","consent","cta"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","description":"The question (a message screen's heading). Required on a create. A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"object","description":"The question (a message screen's heading). Required on a create. A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].text.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].text","typeLabel":"string | object"},"ref":{"type":"string","description":"Your name for the question within the request (1 to 64 characters, not a UUID): logic jumps and after name it. Create only.","maxLength":64,"uniqueKey":"questions.items.[INDEX].ref","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Words under the question.","uniqueKey":"questions.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"object","description":"Words under the question.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].description.oneOf.1","typeLabel":"object"},{"type":"null","description":"Words under the question.","uniqueKey":"questions.items.[INDEX].description.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].description","typeLabel":"string | object | null"},"required":{"type":"boolean","description":"The editor's default for the type when left out (requiredByDefault). A message screen and a call to action can't be required.","uniqueKey":"questions.items.[INDEX].required","typeLabel":"boolean"},"logic":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"One the question type offers (GET /surveys/capabilities, logicOperators).","enum":["equals","not_equals","contains","not_contains","gt","gte","lt","lte","answered","not_answered"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"then":{"oneOf":[{"type":"string","description":"end, or { \"goto\": a ref of the same request or a question id }.","enum":["end"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].then.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"end, or { \"goto\": a ref of the same request or a question id }.","required":["goto"],"properties":{"goto":{"type":"string","isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].then.oneOf.1.goto","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].then.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].then","typeLabel":"enum\u003cstring> | object"},"answer":{"oneOf":[{"description":"What the answer is compared with, as text or JSON: an option's or a face's position counting from 1, or its words, a number, true or false, clicked or dismissed, a this-or-that side's words, or text. Not taken by answered and not_answered.","type":"string","uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].answer.oneOf.0","typeLabel":"string"},{"description":"What the answer is compared with, as text or JSON: an option's or a face's position counting from 1, or its words, a number, true or false, clicked or dismissed, a this-or-that side's words, or text. Not taken by answered and not_answered.","type":"number","uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].answer.oneOf.1","typeLabel":"number"},{"description":"What the answer is compared with, as text or JSON: an option's or a face's position counting from 1, or its words, a number, true or false, clicked or dismissed, a this-or-that side's words, or text. Not taken by answered and not_answered.","type":"boolean","uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].answer.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX].answer","typeLabel":"string | number | boolean"}},"required":["op","then"],"description":"A logic rule. Logic runs in the steps and chat display modes.","additionalProperties":false,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Replaces the question's rules; null or [] removes them. Not on a message screen.","maxItems":50,"uniqueKey":"questions.items.[INDEX].logic.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Replaces the question's rules; null or [] removes them. Not on a message screen.","uniqueKey":"questions.items.[INDEX].logic.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].logic","typeLabel":"object[] | null"},"title":{"oneOf":[{"type":"string","description":"welcome: the heading.","uniqueKey":"questions.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome: the heading.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].title.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome: the heading.","uniqueKey":"questions.items.[INDEX].title.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].title","typeLabel":"string | object | null"},"body":{"oneOf":[{"type":"string","description":"welcome, cta: one paragraph.","uniqueKey":"questions.items.[INDEX].body.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome, cta: one paragraph.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].body.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome, cta: one paragraph.","uniqueKey":"questions.items.[INDEX].body.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].body","typeLabel":"string | object | null"},"buttonText":{"oneOf":[{"type":"string","description":"welcome, cta.","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome, cta.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome, cta.","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonText","typeLabel":"string | object | null"},"buttonUrl":{"oneOf":[{"type":"string","description":"cta: the link (https); publishing needs one.","maxLength":2048,"uniqueKey":"questions.items.[INDEX].buttonUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"cta: the link (https); publishing needs one.","maxLength":2048,"uniqueKey":"questions.items.[INDEX].buttonUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonUrl","typeLabel":"string | null"},"options":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX]","typeLabel":"string | object"},"description":"multiple_choice, dropdown, ranking, allocation. Replaces the list; an option whose words stay keeps its value.","maxItems":250,"uniqueKey":"questions.items.[INDEX].options","typeLabel":"(string | object)[]"},"multiple":{"type":"boolean","description":"multiple_choice, dropdown, matrix: more than one answer.","uniqueKey":"questions.items.[INDEX].multiple","typeLabel":"boolean"},"allowOther":{"type":"boolean","description":"multiple_choice, dropdown: an Other answer.","uniqueKey":"questions.items.[INDEX].allowOther","typeLabel":"boolean"},"faces":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"emoji":{"type":"string","maxLength":16,"isRequired":true,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].emoji","typeLabel":"string"},"label":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1","typeLabel":"object"},{"type":"null","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label","typeLabel":"string | object | null"}},"required":["emoji"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"emoji, dial: worst to best. On a dial without lowLabel and highLabel the first and last faces' words are the ends; an emoji scale shows no ends.","maxItems":7,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"emoji, dial: worst to best. On a dial without lowLabel and highLabel the first and last faces' words are the ends; an emoji scale shows no ends.","uniqueKey":"questions.items.[INDEX].faces.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces","typeLabel":"object[] | null"},"rows":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX]","typeLabel":"string | object"},"description":"matrix: the statements.","maxItems":50,"uniqueKey":"questions.items.[INDEX].rows","typeLabel":"(string | object)[]"},"columns":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX]","typeLabel":"string | object"},"description":"matrix: the answers.","maxItems":20,"uniqueKey":"questions.items.[INDEX].columns","typeLabel":"(string | object)[]"},"pairs":{"type":"array","items":{"type":"object","properties":{"a":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a","typeLabel":"string | object"},"b":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b","typeLabel":"string | object"}},"required":["a","b"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX]","typeLabel":"object"},"description":"this_or_that.","maxItems":50,"uniqueKey":"questions.items.[INDEX].pairs","typeLabel":"object[]"},"points":{"oneOf":[{"type":"integer","description":"rating: how many points (2 to 10, default 5).","minimum":2,"maximum":10,"uniqueKey":"questions.items.[INDEX].points.oneOf.0","typeLabel":"integer"},{"type":"null","description":"rating: how many points (2 to 10, default 5).","minimum":2,"maximum":10,"uniqueKey":"questions.items.[INDEX].points.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].points","typeLabel":"integer | null"},"min":{"oneOf":[{"type":"number","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].min.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].min","typeLabel":"number | null"},"max":{"oneOf":[{"type":"number","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].max.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].max","typeLabel":"number | null"},"step":{"oneOf":[{"type":"number","description":"slider, ruler, number; allocation 1 to 100.","uniqueKey":"questions.items.[INDEX].step.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, ruler, number; allocation 1 to 100.","uniqueKey":"questions.items.[INDEX].step.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].step","typeLabel":"number | null"},"lowLabel":{"oneOf":[{"type":"string","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].lowLabel","typeLabel":"string | object | null"},"highLabel":{"oneOf":[{"type":"string","description":"The high end.","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"The high end.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"The high end.","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].highLabel","typeLabel":"string | object | null"},"placeholder":{"oneOf":[{"type":"string","description":"text, number, dropdown.","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.0","typeLabel":"string"},{"type":"object","description":"text, number, dropdown.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1","typeLabel":"object"},{"type":"null","description":"text, number, dropdown.","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].placeholder","typeLabel":"string | object | null"},"dateMode":{"type":"string","description":"date.","enum":["date","datetime-local","time"],"uniqueKey":"questions.items.[INDEX].dateMode","typeLabel":"enum\u003cstring>"},"contactFields":{"type":"array","items":{"type":"string","enum":["name","email","phone","company","message"],"uniqueKey":"questions.items.[INDEX].contactFields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"contact (default name and email). Required through the email field, else the first.","maxItems":5,"uniqueKey":"questions.items.[INDEX].contactFields","typeLabel":"enum\u003cstring>[]"},"yesLabel":{"oneOf":[{"type":"string","description":"boolean.","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"boolean.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"boolean.","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].yesLabel","typeLabel":"string | object | null"},"noLabel":{"oneOf":[{"type":"string","description":"boolean.","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"boolean.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"boolean.","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].noLabel","typeLabel":"string | object | null"},"checkboxLabel":{"oneOf":[{"type":"string","description":"consent: the words beside the box.","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"consent: the words beside the box.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"consent: the words beside the box.","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].checkboxLabel","typeLabel":"string | object | null"}},"required":["type","text"],"description":"A question in the typed shape. Each type takes the common fields and its own (GET /surveys/capabilities); any other field is 400 PUB-008-001.","additionalProperties":false,"examples":[{"ref":"q1","type":"nps","text":"How likely are you to recommend Usertick?","lowLabel":"Not likely","highLabel":"Very likely","logic":[{"op":"lte","answer":"6","then":{"goto":"q2"}}]},{"ref":"q2","type":"text","text":"What went wrong?","placeholder":"Tell us more"}],"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"maxItems":200,"uniqueKey":"questions","typeLabel":"object[]"}},"required":["name"],"description":"Any other field is 400 PUB-008-001.","additionalProperties":false,"examples":[{"name":"Checkout NPS","channel":"website","defaultLanguage":"en","languages":["en","de"],"displayMode":"steps","position":"bottom-right","texts":{"title":"Quick question","submitButton":{"en":"Send","de":"Senden"}},"targeting":{"pages":{"include":[{"op":"contains","value":"/checkout"}]},"trigger":{"type":"delay","seconds":5},"devices":["desktop","mobile"],"frequency":{"type":"until_response"}},"questions":[{"ref":"q1","type":"nps","text":"How likely are you to recommend Usertick?","lowLabel":"Not likely","highLabel":"Very likely","logic":[{"op":"lte","answer":"6","then":{"goto":"q2"}}]},{"ref":"q2","type":"text","text":"What went wrong?"}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Checkout NPS","channel":"website","defaultLanguage":"en","languages":["en","de"],"displayMode":"steps","position":"bottom-right","texts":{"title":"Quick question","submitButton":{"en":"Send","de":"Senden"}},"targeting":{"pages":{"include":[{"op":"contains","value":"/checkout"}]},"trigger":{"type":"delay","seconds":5},"devices":["desktop","mobile"],"frequency":{"type":"until_response"}},"questions":[{"ref":"q1","type":"nps","text":"How likely are you to recommend Usertick?","lowLabel":"Not likely","highLabel":"Very likely","logic":[{"op":"lte","answer":"6","then":{"goto":"q2"}}]},{"ref":"q2","type":"text","text":"What went wrong?"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d7b696fd-ebdd-410a-b3ec-99dc4541e40b":{"description":"Created.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"The credential's requests per minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"What is left of it now.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the credential's budget is full again (the bucket refills continuously).","schema":{"type":"integer"}},"X-RateLimit-Org-Limit":{"description":"Every credential of the organization together, per minute.","schema":{"type":"integer"}},"X-RateLimit-Org-Remaining":{"description":"What is left of the organization's budget.","schema":{"type":"integer"}},"X-RateLimit-Org-Reset":{"description":"Seconds until the organization's budget is full again.","schema":{"type":"integer"}},"X-RateLimit-Window":{"description":"The window both budgets count over: 60s, since they are requests per minute.","schema":{"type":"string"}},"Location":{"description":"The job to follow.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"true when this is the kept answer of an earlier request with the same Idempotency-Key.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["draft","active","paused","archived"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"channel":{"type":"string","enum":["website","link","email"],"isRequired":true,"uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"site":{"oneOf":[{"type":"object","required":["id","domain"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"site.oneOf.0.id","typeLabel":"string\u003cuuid>"},"domain":{"type":"string","isRequired":true,"uniqueKey":"site.oneOf.0.domain","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"site.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"site.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"site","typeLabel":"object | null"},"draftVersion":{"type":"integer","description":"Send it back as expectedDraftVersion.","isRequired":true,"uniqueKey":"draftVersion","typeLabel":"integer"},"editable":{"type":"boolean","description":"True only for a survey in draft status: the API edits nothing else.","isRequired":true,"uniqueKey":"editable","typeLabel":"boolean"},"editorUrl":{"type":"string","description":"The survey in the Usertick editor, where a person publishes it. Give it to the person.","format":"uri","isRequired":true,"uniqueKey":"editorUrl","typeLabel":"string\u003curi>"},"defaultLanguage":{"type":"string","isRequired":true,"uniqueKey":"defaultLanguage","typeLabel":"string"},"languages":{"type":"array","items":{"type":"string","uniqueKey":"languages.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"languages","typeLabel":"string[]"},"displayMode":{"type":"string","enum":["steps","all","chat"],"isRequired":true,"uniqueKey":"displayMode","typeLabel":"enum\u003cstring>"},"position":{"type":"string","isRequired":true,"uniqueKey":"position","typeLabel":"string"},"texts":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"texts.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"texts.additionalProperties.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"texts.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"texts.additionalProperties","typeLabel":"string | object"},"isRequired":true,"uniqueKey":"texts","typeLabel":"object"},"targeting":{"type":"object","properties":{"pages":{"oneOf":[{"type":"object","description":"Null for every page.","required":["target","include","exclude"],"properties":{"target":{"type":"string","enum":["path","url"],"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.target","typeLabel":"enum\u003cstring>"},"include":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["contains","equals","starts_with","ends_with","regex"],"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].value","typeLabel":"string"},"target":{"type":"string","enum":["path","url"],"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"required":["op","value"],"additionalProperties":false,"uniqueKey":"targeting.pages.oneOf.0.include.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.include","typeLabel":"object[]"},"exclude":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["contains","equals","starts_with","ends_with","regex"],"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].value","typeLabel":"string"},"target":{"type":"string","enum":["path","url"],"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX].target","typeLabel":"enum\u003cstring>"}},"required":["op","value"],"additionalProperties":false,"uniqueKey":"targeting.pages.oneOf.0.exclude.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0.exclude","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"targeting.pages.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null for every page.","isRequired":true,"uniqueKey":"targeting.pages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"targeting.pages","typeLabel":"object | null"},"trigger":{"oneOf":[{"type":"object","description":"Null for none, or for a trigger outside this subset (extraSettings).","required":["type"],"properties":{"type":{"type":"string","enum":["load","delay","scroll","exit_intent","time_on_site"],"isRequired":true,"uniqueKey":"targeting.trigger.oneOf.0.type","typeLabel":"enum\u003cstring>"},"seconds":{"type":"integer","description":"delay and time_on_site only; left out for the other types.","uniqueKey":"targeting.trigger.oneOf.0.seconds","typeLabel":"integer"},"percent":{"type":"integer","description":"scroll only; left out for the other types.","uniqueKey":"targeting.trigger.oneOf.0.percent","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"targeting.trigger.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null for none, or for a trigger outside this subset (extraSettings).","isRequired":true,"uniqueKey":"targeting.trigger.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"targeting.trigger","typeLabel":"object | null"},"devices":{"type":"array","items":{"type":"string","enum":["desktop","tablet","mobile"],"uniqueKey":"targeting.devices.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"targeting.devices","typeLabel":"enum\u003cstring>[]"},"frequency":{"type":"object","properties":{"type":{"type":"string","enum":["once","until_response","cooldown","always"],"isRequired":true,"uniqueKey":"targeting.frequency.type","typeLabel":"enum\u003cstring>"},"cooldownDays":{"type":"integer","isRequired":true,"uniqueKey":"targeting.frequency.cooldownDays","typeLabel":"integer"},"maxDisplays":{"type":"integer","isRequired":true,"uniqueKey":"targeting.frequency.maxDisplays","typeLabel":"integer"},"afterDismissDays":{"type":"integer","isRequired":true,"uniqueKey":"targeting.frequency.afterDismissDays","typeLabel":"integer"}},"required":["type","cooldownDays","maxDisplays","afterDismissDays"],"additionalProperties":false,"isRequired":true,"uniqueKey":"targeting.frequency","typeLabel":"object"},"extraSettings":{"type":"boolean","description":"The survey holds targeting this subset doesn't show (an advanced trigger, audience rules); an edit keeps it unless it sets that part.","isRequired":true,"uniqueKey":"targeting.extraSettings","typeLabel":"boolean"}},"required":["pages","trigger","devices","frequency","extraSettings"],"additionalProperties":false,"isRequired":true,"uniqueKey":"targeting","typeLabel":"object"},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The question id.","isRequired":true,"uniqueKey":"questions.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"File upload, screenshot and signature questions are added in the dashboard (400 PUB-008-006). A type never changes.","enum":["welcome","nps","rating","ces","emoji","boolean","multiple_choice","dropdown","ranking","slider","text","contact","date","matrix","number","big_scale","ruler","dial","this_or_that","allocation","consent","cta"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"oneOf":[{"type":"string","description":"The question (a message screen's heading). Required on a create. A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"object","description":"The question (a message screen's heading). Required on a create. A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].text.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].text.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].text","typeLabel":"string | object"},"required":{"type":"boolean","description":"The editor's default for the type when left out (requiredByDefault). A message screen and a call to action can't be required.","isRequired":true,"uniqueKey":"questions.items.[INDEX].required","typeLabel":"boolean"},"aiGenerated":{"type":"boolean","description":"True when Usertick AI wrote text in this question, in any of its languages: a draft from Create with AI, a generated or suggested question, suggested options or labels, a rewrite or a translation. The mark records where the text came from, so it stays true after a person edits the text. Read only: an edit never sends it.","isRequired":true,"uniqueKey":"questions.items.[INDEX].aiGenerated","typeLabel":"boolean"},"aiGeneratedAt":{"oneOf":[{"type":"string","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].aiGeneratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].aiGeneratedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].aiGeneratedAt","typeLabel":"string\u003cdate-time> | null"},"ref":{"type":"string","description":"On a question this request added: your ref.","uniqueKey":"questions.items.[INDEX].ref","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Words under the question.","uniqueKey":"questions.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"object","description":"Words under the question.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].description.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].description.oneOf.1","typeLabel":"object"},{"type":"null","description":"Words under the question.","uniqueKey":"questions.items.[INDEX].description.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].description","typeLabel":"string | object | null"},"title":{"oneOf":[{"type":"string","description":"welcome: the heading.","uniqueKey":"questions.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome: the heading.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].title.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].title.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome: the heading.","uniqueKey":"questions.items.[INDEX].title.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].title","typeLabel":"string | object | null"},"body":{"oneOf":[{"type":"string","description":"welcome, cta: one paragraph.","uniqueKey":"questions.items.[INDEX].body.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome, cta: one paragraph.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].body.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].body.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome, cta: one paragraph.","uniqueKey":"questions.items.[INDEX].body.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].body","typeLabel":"string | object | null"},"buttonText":{"oneOf":[{"type":"string","description":"welcome, cta.","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.0","typeLabel":"string"},{"type":"object","description":"welcome, cta.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].buttonText.oneOf.1","typeLabel":"object"},{"type":"null","description":"welcome, cta.","uniqueKey":"questions.items.[INDEX].buttonText.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonText","typeLabel":"string | object | null"},"buttonUrl":{"oneOf":[{"type":"string","description":"cta: the link (https); publishing needs one.","maxLength":2048,"uniqueKey":"questions.items.[INDEX].buttonUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"cta: the link (https); publishing needs one.","maxLength":2048,"uniqueKey":"questions.items.[INDEX].buttonUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].buttonUrl","typeLabel":"string | null"},"options":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].options.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].options.items.[INDEX]","typeLabel":"string | object"},"description":"multiple_choice, dropdown, ranking, allocation. Replaces the list; an option whose words stay keeps its value.","maxItems":250,"uniqueKey":"questions.items.[INDEX].options","typeLabel":"(string | object)[]"},"multiple":{"type":"boolean","description":"multiple_choice, dropdown, matrix: more than one answer.","uniqueKey":"questions.items.[INDEX].multiple","typeLabel":"boolean"},"allowOther":{"type":"boolean","description":"multiple_choice, dropdown: an Other answer.","uniqueKey":"questions.items.[INDEX].allowOther","typeLabel":"boolean"},"faces":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"emoji":{"type":"string","maxLength":16,"isRequired":true,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].emoji","typeLabel":"string"},"label":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.1","typeLabel":"object"},{"type":"null","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX].label","typeLabel":"string | object | null"}},"required":["emoji"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"emoji, dial: worst to best. On a dial without lowLabel and highLabel the first and last faces' words are the ends; an emoji scale shows no ends.","maxItems":7,"uniqueKey":"questions.items.[INDEX].faces.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"emoji, dial: worst to best. On a dial without lowLabel and highLabel the first and last faces' words are the ends; an emoji scale shows no ends.","uniqueKey":"questions.items.[INDEX].faces.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].faces","typeLabel":"object[] | null"},"rows":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].rows.items.[INDEX]","typeLabel":"string | object"},"description":"matrix: the statements.","maxItems":50,"uniqueKey":"questions.items.[INDEX].rows","typeLabel":"(string | object)[]"},"columns":{"type":"array","items":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].columns.items.[INDEX]","typeLabel":"string | object"},"description":"matrix: the answers.","maxItems":20,"uniqueKey":"questions.items.[INDEX].columns","typeLabel":"(string | object)[]"},"pairs":{"type":"array","items":{"type":"object","properties":{"a":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].a","typeLabel":"string | object"},"b":{"oneOf":[{"type":"string","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.0","typeLabel":"string"},{"type":"object","description":"A string in the survey's default language, or a map of language to text (languages the survey has). On an edit a string replaces the field and its translations; a map sets those languages and keeps the others, null removing one.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1.additionalProperties","typeLabel":"string | null"},"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX].b","typeLabel":"string | object"}},"required":["a","b"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].pairs.items.[INDEX]","typeLabel":"object"},"description":"this_or_that.","maxItems":50,"uniqueKey":"questions.items.[INDEX].pairs","typeLabel":"object[]"},"points":{"oneOf":[{"type":"integer","description":"rating: how many points (2 to 10, default 5).","minimum":2,"maximum":10,"uniqueKey":"questions.items.[INDEX].points.oneOf.0","typeLabel":"integer"},{"type":"null","description":"rating: how many points (2 to 10, default 5).","minimum":2,"maximum":10,"uniqueKey":"questions.items.[INDEX].points.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].points","typeLabel":"integer | null"},"min":{"oneOf":[{"type":"number","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].min.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].min","typeLabel":"number | null"},"max":{"oneOf":[{"type":"number","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].max.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, big_scale, ruler, number.","uniqueKey":"questions.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].max","typeLabel":"number | null"},"step":{"oneOf":[{"type":"number","description":"slider, ruler, number; allocation 1 to 100.","uniqueKey":"questions.items.[INDEX].step.oneOf.0","typeLabel":"number"},{"type":"null","description":"slider, ruler, number; allocation 1 to 100.","uniqueKey":"questions.items.[INDEX].step.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].step","typeLabel":"number | null"},"lowLabel":{"oneOf":[{"type":"string","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"The low end: nps, rating, ces, dial, slider, big_scale, ruler.","uniqueKey":"questions.items.[INDEX].lowLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].lowLabel","typeLabel":"string | object | null"},"highLabel":{"oneOf":[{"type":"string","description":"The high end.","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"The high end.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].highLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"The high end.","uniqueKey":"questions.items.[INDEX].highLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].highLabel","typeLabel":"string | object | null"},"placeholder":{"oneOf":[{"type":"string","description":"text, number, dropdown.","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.0","typeLabel":"string"},{"type":"object","description":"text, number, dropdown.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].placeholder.oneOf.1","typeLabel":"object"},{"type":"null","description":"text, number, dropdown.","uniqueKey":"questions.items.[INDEX].placeholder.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].placeholder","typeLabel":"string | object | null"},"dateMode":{"type":"string","description":"date.","enum":["date","datetime-local","time"],"uniqueKey":"questions.items.[INDEX].dateMode","typeLabel":"enum\u003cstring>"},"contactFields":{"type":"array","items":{"type":"string","enum":["name","email","phone","company","message"],"uniqueKey":"questions.items.[INDEX].contactFields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"contact (default name and email). Required through the email field, else the first.","maxItems":5,"uniqueKey":"questions.items.[INDEX].contactFields","typeLabel":"enum\u003cstring>[]"},"yesLabel":{"oneOf":[{"type":"string","description":"boolean.","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"boolean.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"boolean.","uniqueKey":"questions.items.[INDEX].yesLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].yesLabel","typeLabel":"string | object | null"},"noLabel":{"oneOf":[{"type":"string","description":"boolean.","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"boolean.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].noLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"boolean.","uniqueKey":"questions.items.[INDEX].noLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].noLabel","typeLabel":"string | object | null"},"checkboxLabel":{"oneOf":[{"type":"string","description":"consent: the words beside the box.","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.0","typeLabel":"string"},{"type":"object","description":"consent: the words beside the box.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1.additionalProperties","typeLabel":"string | null"},"uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.1","typeLabel":"object"},{"type":"null","description":"consent: the words beside the box.","uniqueKey":"questions.items.[INDEX].checkboxLabel.oneOf.2","typeLabel":"null"}],"uniqueKey":"questions.items.[INDEX].checkboxLabel","typeLabel":"string | object | null"},"logic":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["equals","not_equals","contains","not_contains","gt","gte","lt","lte","answered","not_answered"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"then":{"oneOf":[{"type":"string","description":"Null for a rule with no destination yet (publishing asks for one).","enum":["end"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].then.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Null for a rule with no destination yet (publishing asks for one).","required":["goto"],"properties":{"goto":{"type":"string","description":"A question id.","isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].then.oneOf.1.goto","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].then.oneOf.1","typeLabel":"object"},{"type":"null","description":"Null for a rule with no destination yet (publishing asks for one).","isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].then.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].then","typeLabel":"enum\u003cstring> | object | null"},"answer":{"oneOf":[{"type":"string","uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].answer.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].answer.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].answer.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX].answer","typeLabel":"string | number | boolean"}},"required":["op","then"],"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].logic.items.[INDEX]","typeLabel":"object"},"description":"Not on a message screen.","uniqueKey":"questions.items.[INDEX].logic","typeLabel":"object[]"},"extraSettings":{"type":"boolean","description":"Only when true: the question holds settings this shape doesn't show (a picture, a timer, a page); an edit keeps them.","uniqueKey":"questions.items.[INDEX].extraSettings","typeLabel":"boolean"}},"required":["id","type","text","required","aiGenerated","aiGeneratedAt"],"description":"A question in the typed shape: the common fields and the type's own that it holds.","additionalProperties":false,"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"questions","typeLabel":"object[]"},"publishChecks":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code publishing answers with.","isRequired":true,"uniqueKey":"publishChecks.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"publishChecks.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"publishChecks.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"publishChecks.items.[INDEX].message","typeLabel":"string | null"}},"required":["code","message"],"additionalProperties":false,"uniqueKey":"publishChecks.items.[INDEX]","typeLabel":"object"},"description":"What publishing would refuse now: a report for the person who publishes. Nothing here blocks saving a draft.","isRequired":true,"uniqueKey":"publishChecks","typeLabel":"object[]"},"createdAt":{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"aiGenerated":{"type":"boolean","description":"True when Usertick AI wrote text in the survey's own fields; each question has its own. Read only.","isRequired":true,"uniqueKey":"aiGenerated","typeLabel":"boolean"},"aiGeneratedAt":{"oneOf":[{"type":"string","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"aiGeneratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"aiGeneratedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"aiGeneratedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","name","status","channel","site","draftVersion","editable","editorUrl","defaultLanguage","languages","displayMode","position","texts","targeting","questions","publishChecks","createdAt","updatedAt","aiGenerated","aiGeneratedAt"],"additionalProperties":false,"examples":[{"id":"11111111-1111-4111-8111-111111111111","name":"Checkout NPS","status":"draft","channel":"website","site":{"id":"22222222-2222-4222-8222-222222222222","domain":"shop.example.com"},"draftVersion":1,"editable":true,"editorUrl":"https://app.usertick.com/surveys?edit=11111111-1111-4111-8111-111111111111\u0026org=3c9e4e1a-5b7d-4f20-9a61-0c2d8e4f6a10","defaultLanguage":"en","languages":["en"],"displayMode":"steps","position":"bottom-right","texts":{},"targeting":{"pages":null,"trigger":{"type":"delay","seconds":5},"devices":["desktop","tablet","mobile"],"frequency":{"type":"until_response","cooldownDays":30,"maxDisplays":0,"afterDismissDays":0},"extraSettings":false},"questions":[{"id":"a0000000-0000-4000-8000-000000000005","ref":"q1","type":"nps","text":"How likely are you to recommend Usertick?","required":true,"lowLabel":"Not likely","highLabel":"Very likely","logic":[],"aiGenerated":false,"aiGeneratedAt":null}],"publishChecks":[],"createdAt":"2026-11-03T10:00:00.000Z","updatedAt":"2026-11-03T10:00:00.000Z","aiGenerated":false,"aiGeneratedAt":null}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"11111111-1111-4111-8111-111111111111","name":"Checkout NPS","status":"draft","channel":"website","site":{"id":"22222222-2222-4222-8222-222222222222","domain":"shop.example.com"},"draftVersion":1,"editable":true,"editorUrl":"https://app.usertick.com/surveys?edit=11111111-1111-4111-8111-111111111111\u0026org=3c9e4e1a-5b7d-4f20-9a61-0c2d8e4f6a10","defaultLanguage":"en","languages":["en"],"displayMode":"steps","position":"bottom-right","texts":{},"targeting":{"pages":null,"trigger":{"type":"delay","seconds":5},"devices":["desktop","tablet","mobile"],"frequency":{"type":"until_response","cooldownDays":30,"maxDisplays":0,"afterDismissDays":0},"extraSettings":false},"questions":[{"id":"a0000000-0000-4000-8000-000000000005","ref":"q1","type":"nps","text":"How likely are you to recommend Usertick?","required":true,"lowLabel":"Not likely","highLabel":"Very likely","logic":[],"aiGenerated":false,"aiGeneratedAt":null}],"publishChecks":[],"createdAt":"2026-11-03T10:00:00.000Z","updatedAt":"2026-11-03T10:00:00.000Z","aiGenerated":false,"aiGeneratedAt":null}}},"exampleType":"generated"}},"exampleType":"generated"},"fe7c7207-3e74-473e-a6bf-984cebf6f13a":{"description":"The request isn't valid. Codes: GEN-000-003, PUB-001-004, PUB-001-006, PUB-008-001, PUB-008-002, PUB-008-006, PUB-008-009, PUB-008-010, SRV-006-002, SRV-006-003, SRV-006-004, SRV-006-009, SRV-006-010, SRV-006-011, SRV-006-012, SRV-006-015, QST-001-010, QST-001-011, QST-001-012, QST-001-013, SRV-001-001, SRV-001-002, SRV-001-003, SRV-001-010, SRV-001-012, SRV-001-013, SRV-001-014, SRV-001-015, SRV-001-020, SRV-001-023, SRV-001-024, SRV-001-025, SRV-001-026, SRV-001-029, SRV-001-030, SRV-001-033, SRV-001-034, PUB-002-001.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"true when this is the kept answer of an earlier request with the same Idempotency-Key.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"GEN-000-003":{"title":"GEN-000-003","summary":"Some fields aren't valid. Check them and try again.","value":{"statusCode":400,"success":false,"code":"GEN-000-003","message":"Some fields aren't valid. Check them and try again.","data":null}},"PUB-001-004":{"title":"PUB-001-004","summary":"This value isn't valid.","value":{"statusCode":400,"success":false,"code":"PUB-001-004","message":"This value isn't valid.","data":null}},"PUB-001-006":{"title":"PUB-001-006","summary":"Send a JSON body that this endpoint accepts.","value":{"statusCode":400,"success":false,"code":"PUB-001-006","message":"Send a JSON body that this endpoint accepts.","data":null}},"PUB-008-001":{"title":"PUB-008-001","summary":"This field isn't taken here. GET /surveys/capabilities lists the fields each question type takes, and the operations list theirs.","value":{"statusCode":400,"success":false,"code":"PUB-008-001","message":"This field isn't taken here. GET /surveys/capabilities lists the fields each question type takes, and the operations list theirs.","data":null}},"PUB-008-002":{"title":"PUB-008-002","summary":"No question of this survey has this ref or ID. Use a ref from the same request or a question ID from GET /surveys/{surveyId}/draft.","value":{"statusCode":400,"success":false,"code":"PUB-008-002","message":"No question of this survey has this ref or ID. Use a ref from the same request or a question ID from GET /surveys/{surveyId}/draft.","data":null}},"PUB-008-006":{"title":"PUB-008-006","summary":"This question type can't be created through the API, or the question's type can't change. File upload, screenshot and signature questions are added in the dashboard. To change a type, remove the question and add a new one.","value":{"statusCode":400,"success":false,"code":"PUB-008-006","message":"This question type can't be created through the API, or the question's type can't change. File upload, screenshot and signature questions are added in the dashboard. To change a type, remove the question and add a new one.","data":null}},"PUB-008-009":{"title":"PUB-008-009","summary":"This channel isn't offered through the API. Use website or link. Email surveys are created in the Usertick dashboard.","value":{"statusCode":400,"success":false,"code":"PUB-008-009","message":"This channel isn't offered through the API. Use website or link. Email surveys are created in the Usertick dashboard.","data":null}},"PUB-008-010":{"title":"PUB-008-010","summary":"This language isn't one the survey offers. Add it to languages first, using a language GET /surveys/capabilities lists.","value":{"statusCode":400,"success":false,"code":"PUB-008-010","message":"This language isn't one the survey offers. Add it to languages first, using a language GET /surveys/capabilities lists.","data":null}},"SRV-006-002":{"title":"SRV-006-002","summary":"A logic rule uses an operator that isn't valid.","value":{"statusCode":400,"success":false,"code":"SRV-006-002","message":"A logic rule uses an operator that isn't valid.","data":null}},"SRV-006-003":{"title":"SRV-006-003","summary":"A logic rule uses an action that isn't valid.","value":{"statusCode":400,"success":false,"code":"SRV-006-003","message":"A logic rule uses an action that isn't valid.","data":null}},"SRV-006-004":{"title":"SRV-006-004","summary":"A logic rule isn't structured correctly.","value":{"statusCode":400,"success":false,"code":"SRV-006-004","message":"A logic rule isn't structured correctly.","data":null}},"SRV-006-009":{"title":"SRV-006-009","summary":"A question has too many items or a setting outside its allowed range.","value":{"statusCode":400,"success":false,"code":"SRV-006-009","message":"A question has too many items or a setting outside its allowed range.","data":null}},"SRV-006-010":{"title":"SRV-006-010","summary":"A question text isn't valid. Each text must be a string or a map of language tag to string.","value":{"statusCode":400,"success":false,"code":"SRV-006-010","message":"A question text isn't valid. Each text must be a string or a map of language tag to string.","data":null}},"SRV-006-011":{"title":"SRV-006-011","summary":"A question setting has a key that starts with a capital letter or is spelled two ways. Use one spelling for each key.","value":{"statusCode":400,"success":false,"code":"SRV-006-011","message":"A question setting has a key that starts with a capital letter or is spelled two ways. Use one spelling for each key.","data":null}},"SRV-006-012":{"title":"SRV-006-012","summary":"A question holds a number too large to store or text with invalid characters. Correct the value and save again.","value":{"statusCode":400,"success":false,"code":"SRV-006-012","message":"A question holds a number too large to store or text with invalid characters. Correct the value and save again.","data":null}},"SRV-006-015":{"title":"SRV-006-015","summary":"A logic rule's text to match is longer than 500 characters. Shorten the text, then save again.","value":{"statusCode":400,"success":false,"code":"SRV-006-015","message":"A logic rule's text to match is longer than 500 characters. Shorten the text, then save again.","data":null}},"QST-001-010":{"title":"QST-001-010","summary":"Question label is too long.","value":{"statusCode":400,"success":false,"code":"QST-001-010","message":"Question label is too long.","data":null}},"QST-001-011":{"title":"QST-001-011","summary":"A question option or setting is too long.","value":{"statusCode":400,"success":false,"code":"QST-001-011","message":"A question option or setting is too long.","data":null}},"QST-001-012":{"title":"QST-001-012","summary":"Question settings are too large.","value":{"statusCode":400,"success":false,"code":"QST-001-012","message":"Question settings are too large.","data":null}},"QST-001-013":{"title":"QST-001-013","summary":"A question couldn't be saved because its ID is too long. Reload the page and try again.","value":{"statusCode":400,"success":false,"code":"QST-001-013","message":"A question couldn't be saved because its ID is too long. Reload the page and try again.","data":null}},"SRV-001-001":{"title":"SRV-001-001","summary":"Survey name is required.","value":{"statusCode":400,"success":false,"code":"SRV-001-001","message":"Survey name is required.","data":null}},"SRV-001-002":{"title":"SRV-001-002","summary":"Survey name can't be empty.","value":{"statusCode":400,"success":false,"code":"SRV-001-002","message":"Survey name can't be empty.","data":null}},"SRV-001-003":{"title":"SRV-001-003","summary":"Survey name must be between 1 and 255 characters.","value":{"statusCode":400,"success":false,"code":"SRV-001-003","message":"Survey name must be between 1 and 255 characters.","data":null}},"SRV-001-010":{"title":"SRV-001-010","summary":"A survey text is too long.","value":{"statusCode":400,"success":false,"code":"SRV-001-010","message":"A survey text is too long.","data":null}},"SRV-001-012":{"title":"SRV-001-012","summary":"Survey settings are too large.","value":{"statusCode":400,"success":false,"code":"SRV-001-012","message":"Survey settings are too large.","data":null}},"SRV-001-013":{"title":"SRV-001-013","summary":"The trigger settings aren't valid.","value":{"statusCode":400,"success":false,"code":"SRV-001-013","message":"The trigger settings aren't valid.","data":null}},"SRV-001-014":{"title":"SRV-001-014","summary":"The page rules aren't valid.","value":{"statusCode":400,"success":false,"code":"SRV-001-014","message":"The page rules aren't valid.","data":null}},"SRV-001-015":{"title":"SRV-001-015","summary":"The frequency settings aren't valid.","value":{"statusCode":400,"success":false,"code":"SRV-001-015","message":"The frequency settings aren't valid.","data":null}},"SRV-001-020":{"title":"SRV-001-020","summary":"A survey can have at most 200 questions.","value":{"statusCode":400,"success":false,"code":"SRV-001-020","message":"A survey can have at most 200 questions.","data":null}},"SRV-001-023":{"title":"SRV-001-023","summary":"This survey has more languages than Usertick offers. To create it, remove languages.","value":{"statusCode":400,"success":false,"code":"SRV-001-023","message":"This survey has more languages than Usertick offers. To create it, remove languages.","data":null}},"SRV-001-024":{"title":"SRV-001-024","summary":"A page, referrer or trigger pattern can't run safely in the browser. Simplify it and check its flags.","value":{"statusCode":400,"success":false,"code":"SRV-001-024","message":"A page, referrer or trigger pattern can't run safely in the browser. Simplify it and check its flags.","data":null}},"SRV-001-025":{"title":"SRV-001-025","summary":"The widget position isn't recognized. Use bottom-right, bottom-left, top-right, top-left or center-modal.","value":{"statusCode":400,"success":false,"code":"SRV-001-025","message":"The widget position isn't recognized. Use bottom-right, bottom-left, top-right, top-left or center-modal.","data":null}},"SRV-001-026":{"title":"SRV-001-026","summary":"The display mode isn't recognized. Use all, steps or chat.","value":{"statusCode":400,"success":false,"code":"SRV-001-026","message":"The display mode isn't recognized. Use all, steps or chat.","data":null}},"SRV-001-029":{"title":"SRV-001-029","summary":"A survey setting has a key that starts with a capital letter or is spelled two ways. Use one spelling for each key.","value":{"statusCode":400,"success":false,"code":"SRV-001-029","message":"A survey setting has a key that starts with a capital letter or is spelled two ways. Use one spelling for each key.","data":null}},"SRV-001-030":{"title":"SRV-001-030","summary":"A survey setting holds a number too large to store or text with invalid characters. Correct the value and try again.","value":{"statusCode":400,"success":false,"code":"SRV-001-030","message":"A survey setting holds a number too large to store or text with invalid characters. Correct the value and try again.","data":null}},"SRV-001-033":{"title":"SRV-001-033","summary":"A survey text or language list isn't valid. Each text must be a string or a map of language tag to string, and each language must be a language tag.","value":{"statusCode":400,"success":false,"code":"SRV-001-033","message":"A survey text or language list isn't valid. Each text must be a string or a map of language tag to string, and each language must be a language tag.","data":null}},"SRV-001-034":{"title":"SRV-001-034","summary":"The display settings aren't valid. Check the devices, the side button icon, the embed selector and the redirect address, then try again.","value":{"statusCode":400,"success":false,"code":"SRV-001-034","message":"The display settings aren't valid. Check the devices, the side button icon, the embed selector and the redirect address, then try again.","data":null}},"PUB-002-001":{"title":"PUB-002-001","summary":"Send an Idempotency-Key of 1 to 255 printable ASCII characters, without a space at either end.","value":{"statusCode":400,"success":false,"code":"PUB-002-001","message":"Send an Idempotency-Key of 1 to 255 printable ASCII characters, without a space at either end.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"1e4fe05c-94c1-48bd-8e23-8722164f82a6":{"description":"No credential, one that is invalid, expired or revoked, or a token an AI assistant got for the MCP server. Codes: APK-004-001, APK-004-002, APK-004-007.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-001":{"title":"APK-004-001","summary":"Send an API key or an access token in the Authorization header.","value":{"statusCode":401,"success":false,"code":"APK-004-001","message":"Send an API key or an access token in the Authorization header.","data":null}},"APK-004-002":{"title":"APK-004-002","summary":"The API key or access token is invalid, expired or revoked. Connect again with a valid one.","value":{"statusCode":401,"success":false,"code":"APK-004-002","message":"The API key or access token is invalid, expired or revoked. Connect again with a valid one.","data":null}},"APK-004-007":{"title":"APK-004-007","summary":"This credential is for another server. The MCP server takes only the access tokens an assistant gets when it signs in, and the REST API takes API keys and app tokens.","value":{"statusCode":401,"success":false,"code":"APK-004-007","message":"This credential is for another server. The MCP server takes only the access tokens an assistant gets when it signs in, and the REST API takes API keys and app tokens.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"b00fc31b-018a-4b48-93dc-0e8fb6cf2b5e":{"description":"The request was refused. Codes: APK-004-004, APK-004-005, APK-004-008, APK-004-009, AUTHZ-001-002, PLN-001-002, PLN-001-003, PLN-001-015, SRV-001-027.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-004":{"title":"APK-004-004","summary":"This API key or app doesn't have permission for this request. Grant it the required scope.","value":{"statusCode":403,"success":false,"code":"APK-004-004","message":"This API key or app doesn't have permission for this request. Grant it the required scope.","data":null}},"APK-004-005":{"title":"APK-004-005","summary":"Your plan doesn't include API keys. To use them, upgrade to Pro or higher.","value":{"statusCode":403,"success":false,"code":"APK-004-005","message":"Your plan doesn't include API keys. To use them, upgrade to Pro or higher.","data":null}},"APK-004-008":{"title":"APK-004-008","summary":"This organization's plan doesn't include apps that use the API, such as Zapier. To use them, contact Usertick sales to change the plan.","value":{"statusCode":403,"success":false,"code":"APK-004-008","message":"This organization's plan doesn't include apps that use the API, such as Zapier. To use them, contact Usertick sales to change the plan.","data":null}},"APK-004-009":{"title":"APK-004-009","summary":"This organization's plan doesn't include the MCP server. To use an AI assistant with Usertick, upgrade to Starter or higher.","value":{"statusCode":403,"success":false,"code":"APK-004-009","message":"This organization's plan doesn't include the MCP server. To use an AI assistant with Usertick, upgrade to Starter or higher.","data":null}},"AUTHZ-001-002":{"title":"AUTHZ-001-002","summary":"Your role doesn't have the required permission.","value":{"statusCode":403,"success":false,"code":"AUTHZ-001-002","message":"Your role doesn't have the required permission.","data":null}},"PLN-001-002":{"title":"PLN-001-002","summary":"The organization has as many surveys as its plan allows, archived ones not counted. To add or restore one, archive a survey or upgrade the plan.","value":{"statusCode":403,"success":false,"code":"PLN-001-002","message":"The organization has as many surveys as its plan allows, archived ones not counted. To add or restore one, archive a survey or upgrade the plan.","data":null}},"PLN-001-003":{"title":"PLN-001-003","summary":"This survey has more questions than your plan allows. To save or publish it, remove questions or upgrade your plan.","value":{"statusCode":403,"success":false,"code":"PLN-001-003","message":"This survey has more questions than your plan allows. To save or publish it, remove questions or upgrade your plan.","data":null}},"PLN-001-015":{"title":"PLN-001-015","summary":"This survey has more questions that collect a file, a screenshot or a signature than your plan allows. To save or publish it, remove one or upgrade to Starter, which has no such limit.","value":{"statusCode":403,"success":false,"code":"PLN-001-015","message":"This survey has more questions that collect a file, a screenshot or a signature than your plan allows. To save or publish it, remove one or upgrade to Starter, which has no such limit.","data":null}},"SRV-001-027":{"title":"SRV-001-027","summary":"This survey has more languages than your plan includes. To create it, remove languages or upgrade your plan.","value":{"statusCode":403,"success":false,"code":"SRV-001-027","message":"This survey has more languages than your plan includes. To create it, remove languages or upgrade your plan.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"2d667ebf-2517-4c96-aa2c-f2524f87aefb":{"description":"The resource couldn't be found. Codes: SIT-002-001.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"true when this is the kept answer of an earlier request with the same Idempotency-Key.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"SIT-002-001":{"title":"SIT-002-001","summary":"The site couldn't be found.","value":{"statusCode":404,"success":false,"code":"SIT-002-001","message":"The site couldn't be found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"c2f3fbad-ac9e-4438-a5ff-dd5284437c43":{"description":"The request conflicts with the current state. Codes: PUB-002-002, PUB-002-003.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before trying again. On a 429 over a budget, the time the bucket takes to refill one request (1 second at 120 or 300 a minute); X-RateLimit-Reset says when the whole budget is back.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"PUB-002-002":{"title":"PUB-002-002","summary":"This Idempotency-Key was used with a different request. Use a new key for a new request.","value":{"statusCode":409,"success":false,"code":"PUB-002-002","message":"This Idempotency-Key was used with a different request. Use a new key for a new request.","data":null}},"PUB-002-003":{"title":"PUB-002-003","summary":"A request with this Idempotency-Key is still running. Try again in a moment.","value":{"statusCode":409,"success":false,"code":"PUB-002-003","message":"A request with this Idempotency-Key is still running. Try again in a moment.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"68652d8b-c586-4b6e-9d8c-1085e1b349d2":{"description":"The body is over 512 KB. Codes: GEN-000-413.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"GEN-000-413":{"title":"GEN-000-413","summary":"The request is too large. Send less data or a smaller file.","value":{"statusCode":413,"success":false,"code":"GEN-000-413","message":"The request is too large. Send less data or a smaller file.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"1f305404-6fe7-4204-a260-30a374ba4c5e":{"description":"The body is not JSON: send it with Content-Type: application/json. Codes: GEN-000-415.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"GEN-000-415":{"title":"GEN-000-415","summary":"The request body isn't JSON. Send it with Content-Type: application/json.","value":{"statusCode":415,"success":false,"code":"GEN-000-415","message":"The request body isn't JSON. Send it with Content-Type: application/json.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"77000033-fc15-4d5b-b472-b12caf1f0f20":{"description":"Over a budget. Codes: APK-004-003, APK-004-006, GEN-429-001, PUB-008-008.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before trying again. On a 429 over a budget, the time the bucket takes to refill one request (1 second at 120 or 300 a minute); X-RateLimit-Reset says when the whole budget is back.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-003":{"title":"APK-004-003","summary":"This API key or app sent too many requests. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"APK-004-003","message":"This API key or app sent too many requests. Wait a minute and try again.","data":null}},"APK-004-006":{"title":"APK-004-006","summary":"Your organization sent too many API requests. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"APK-004-006","message":"Your organization sent too many API requests. Wait a minute and try again.","data":null}},"GEN-429-001":{"title":"GEN-429-001","summary":"Too many requests were sent. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"GEN-429-001","message":"Too many requests were sent. Wait a minute and try again.","data":null}},"PUB-008-008":{"title":"PUB-008-008","summary":"This credential created as many surveys today as the API allows, 200 a day. Try again after the time in Retry-After.","value":{"statusCode":429,"success":false,"code":"PUB-008-008","message":"This credential created as many surveys today as the API allows, 200 a day. Try again after the time in Retry-After.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e6f2970d-e0b1-4f31-89d6-ce42413df7c4":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"}},"c628e213-b100-46e6-8ac3-7d3b1e7a9ebb":{"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"}}},"servers":{"a7da5109-6827-4042-ac09-900ca098b7bc":{"url":"https://app.usertick.com/api/public/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"},"schema":{"title":"X-Api-Key","type":"string","description":"The API key, for clients that cannot send Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyHeader","name":"X-Api-Key"}],"title":"apiKeyHeader"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"usertick","siteName":"Usertick","title":"Create a survey draft - Usertick","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T21:10:16.262Z","gitLastModified":"2026-11-08T21:09:53.000Z","originalFileLocation":"developers/api/reference/create-survey.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan\u0026#x27;s limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key\u0026#x27;s drafts name the key\u0026#x27;s creator. Scopes: surveys:draft, surveys:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Usertick\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a survey draft - Usertick\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan\u0026#x27;s limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key\u0026#x27;s drafts name the key\u0026#x27;s creator. Scopes: surveys:draft, surveys:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Usertick\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usertick.com/developers/api/reference/create-survey\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://usertick.mintlify.site/_mintlify/api/og/v2?division=Surveys\u0026amp;title=Create+a+survey+draft\u0026amp;description=Creates+a+survey+in+draft+status+from+typed+questions%2C+its+words+and+its+targeting+%28the+subset+every+plan+runs%29.+Nothing+goes+live%3A+a+person+publishes+the+draft\u0026amp;theme=5e4c20761a162105c03832f0\u0026amp;signature=d2164ddb65d1e32d7a83ea32466f031b3e6193d55a95c6a388546b8d48a15bec\">\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 survey draft - Usertick\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan\u0026#x27;s limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key\u0026#x27;s drafts name the key\u0026#x27;s creator. Scopes: surveys:draft, surveys:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://usertick.mintlify.site/_mintlify/api/og/v2?division=Surveys\u0026amp;title=Create+a+survey+draft\u0026amp;description=Creates+a+survey+in+draft+status+from+typed+questions%2C+its+words+and+its+targeting+%28the+subset+every+plan+runs%29.+Nothing+goes+live%3A+a+person+publishes+the+draft\u0026amp;theme=5e4c20761a162105c03832f0\u0026amp;signature=d2164ddb65d1e32d7a83ea32466f031b3e6193d55a95c6a388546b8d48a15bec\">\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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Usertick\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF3C00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usertick.com/developers/api/reference/create-survey\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api/reference/create-survey.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://usertick.com/#organization\",\"name\":\"Usertick\",\"legalName\":\"Usertick Ltd\",\"url\":\"https://usertick.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://cdn.usertick.com/brand/Usertick-o-icon.png\"},\"sameAs\":[\"https://www.linkedin.com/company/usertick\",\"https://x.com/Usertick_ltd\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usertick.com#website\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"publisher\":{\"@id\":\"https://usertick.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usertick.com/developers/api/reference/create-survey#webpage\",\"url\":\"https://docs.usertick.com/developers/api/reference/create-survey\",\"name\":\"Create a survey draft\",\"description\":\"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan's limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key's drafts name the key's creator. Scopes: surveys:draft, surveys:read.\",\"dateModified\":\"2026-11-08T21:09:53.000Z\",\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/create-survey#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usertick.com/developers/api/reference/create-survey#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Surveys\",\"item\":\"https://docs.usertick.com/developers/api/reference/list-surveys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a survey draft\",\"item\":\"https://docs.usertick.com/developers/api/reference/create-survey\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usertick.com/developers/api/reference/create-survey#apireference\",\"headline\":\"Create a survey draft\",\"name\":\"Create a survey draft\",\"description\":\"Creates a survey in draft status from typed questions, its words and its targeting (the subset every plan runs). Nothing goes live: a person publishes the draft in Usertick (editorUrl). The questions are checked the way a dashboard save checks them, each error naming its field, and the plan's limits apply as in the dashboard; no Usertick AI credits are used. At most 200 creates a day per credential (429 PUB-008-008 with Retry-After). Answers with the draft (draftVersion, question ids with your refs, publishChecks, editorUrl) and its address in Location. Recorded in the audit log as made through the credential; an API key's drafts name the key's creator. Scopes: surveys:draft, surveys:read.\",\"url\":\"https://docs.usertick.com/developers/api/reference/create-survey\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/create-survey#webpage\"},\"dateModified\":\"2026-11-08T21:09:53.000Z\",\"publisher\":{\"@id\":\"https://usertick.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Usertick\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Usertick\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/api/reference/create-survey.md","siteName":"Usertick","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Install","icon":"code","pages":[{"title":"Install","href":"/installation"}]},{"tab":"Surveys","icon":"square-pen","pages":[{"title":"Surveys","href":"/surveys"}]},{"tab":"Email","icon":"mail","pages":[{"title":"Email","href":"/email"}]},{"tab":"Results","icon":"chart-column","pages":[{"title":"Results","href":"/results"}]},{"tab":"Workflows","icon":"workflow","pages":[{"title":"Workflows","href":"/workflows/overview"}]},{"tab":"Integrations","icon":"blocks","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Settings","icon":"settings","pages":[{"title":"Settings","href":"/account"}]},{"tab":"Developers","icon":"terminal","groups":[{"group":"JavaScript SDK","icon":"braces","root":{"title":"JavaScript SDK","sidebarTitle":"Overview","href":"/developers/sdk/overview"},"directory":"card","pages":[{"title":"SDK reference","href":"/developers/sdk/reference"},{"title":"SDK events","href":"/developers/sdk/events"}]},{"group":"REST API","icon":"server","root":{"title":"REST API","sidebarTitle":"Overview","href":"/developers/api/overview"},"directory":"card","pages":[{"title":"Authentication","href":"/developers/api/authentication"},{"title":"OAuth for apps","href":"/developers/api/oauth"},{"title":"Errors","href":"/developers/api/errors"},{"title":"Rate limits","href":"/developers/api/rate-limits"},{"title":"Pagination","href":"/developers/api/pagination"},{"title":"Idempotency","href":"/developers/api/idempotency"},{"title":"Versioning","href":"/developers/api/versioning"},{"title":"The Response resource","sidebarTitle":"The Response resource","href":"/developers/api/response-object"},{"title":"Share, archive and copy surveys","sidebarTitle":"Share, archive and copy","href":"/developers/api/surveys"},{"title":"Results per question","href":"/developers/api/results"},{"title":"Metrics","href":"/developers/api/metrics"},{"title":"Download files","href":"/developers/api/attachments"},{"title":"Contacts and lists","sidebarTitle":"Contacts and lists","href":"/developers/api/contacts"},{"title":"Email sends","sidebarTitle":"Email sends","href":"/developers/api/email-sends"},{"title":"Dashboard drafts","sidebarTitle":"Dashboard drafts","href":"/developers/api/dashboard-drafts"},{"title":"Workflow drafts","sidebarTitle":"Workflow drafts","href":"/developers/api/workflow-drafts"},{"title":"Exports","sidebarTitle":"Exports","href":"/developers/api/exports"},{"title":"Support tickets","sidebarTitle":"Support tickets","href":"/developers/api/support-tickets"},{"title":"Erase personal data","href":"/developers/api/erasure"}]},{"group":"API reference","pages":[{"group":"Account","pages":[{"title":"Get the current credential","openapi":"api-reference/openapi.json GET /me","href":"/developers/api/reference/get-me"}]},{"group":"Surveys","pages":[{"title":"List surveys","openapi":"api-reference/openapi.json GET /surveys","href":"/developers/api/reference/list-surveys"},{"title":"Get a survey","openapi":"api-reference/openapi.json GET /surveys/{surveyId}","href":"/developers/api/reference/get-survey"},{"title":"Get a survey's share link","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/share","href":"/developers/api/reference/get-survey-share"},{"title":"Get the survey draft guide","openapi":"api-reference/openapi.json GET /surveys/capabilities","description":"What a survey draft takes in this organization: the question types with their typed fields, logic operators and defaults, the survey texts, the languages it offers and the plan allows per survey, the limits (questions per survey, surveys used and allowed, creates per day, operations per edit, list and text lengths), the targeting subset, and the features publishing checks against the plan. Read it before writing a draft.\n\nScopes: surveys:draft.","href":"/developers/api/reference/get-survey-capabilities"},{"title":"Create a survey draft","openapi":"api-reference/openapi.json POST /surveys","href":"/developers/api/reference/create-survey"},{"title":"Get a survey draft","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/draft","description":"A survey in the typed shape with its draft revision (draftVersion), its editor link (editorUrl) and what publishing would refuse now (publishChecks). Any status: editable is true only for a survey in draft status, the one kind the API edits. A question that holds settings the typed shape doesn't show says extraSettings: true, and an edit keeps them.\n\nScopes: surveys:read.","href":"/developers/api/reference/get-survey-draft"},{"title":"Edit a survey draft","openapi":"api-reference/openapi.json PATCH /surveys/{surveyId}/draft","href":"/developers/api/reference/edit-survey-draft"},{"title":"Duplicate a survey as a draft","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/duplicate","href":"/developers/api/reference/duplicate-survey"},{"title":"Pause a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/pause","href":"/developers/api/reference/pause-survey"},{"title":"Resume a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/resume","href":"/developers/api/reference/resume-survey"},{"title":"Archive a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/archive","href":"/developers/api/reference/archive-survey"},{"title":"Restore a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/restore","href":"/developers/api/reference/restore-survey"},{"title":"List sites","openapi":"api-reference/openapi.json GET /sites","href":"/developers/api/reference/list-sites"}]},{"group":"Responses","pages":[{"title":"List responses","openapi":"api-reference/openapi.json GET /responses","href":"/developers/api/reference/list-responses"},{"title":"List recent responses","openapi":"api-reference/openapi.json GET /responses/recent","href":"/developers/api/reference/list-recent-responses"},{"title":"Get a response","openapi":"api-reference/openapi.json GET /responses/{responseId}","href":"/developers/api/reference/get-response"},{"title":"Update a response","openapi":"api-reference/openapi.json PATCH /responses/{responseId}","href":"/developers/api/reference/update-response"},{"title":"List the analysis tree","openapi":"api-reference/openapi.json GET /themes","href":"/developers/api/reference/list-themes"},{"title":"List members","openapi":"api-reference/openapi.json GET /members","href":"/developers/api/reference/list-members"},{"title":"Download a respondent's file","openapi":"api-reference/openapi.json GET /responses/{responseId}/attachments/{attachmentId}","href":"/developers/api/reference/get-attachment"}]},{"group":"Notes","pages":[{"title":"List notes","openapi":"api-reference/openapi.json GET /responses/{responseId}/comments","href":"/developers/api/reference/list-comments"},{"title":"Add a note","openapi":"api-reference/openapi.json POST /responses/{responseId}/comments","href":"/developers/api/reference/add-comment"},{"title":"Edit a note","openapi":"api-reference/openapi.json PATCH /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/edit-comment"},{"title":"Delete a note","openapi":"api-reference/openapi.json DELETE /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/delete-comment"}]},{"group":"Erasure","pages":[{"title":"Erase a response","openapi":"api-reference/openapi.json DELETE /responses/{responseId}","href":"/developers/api/reference/delete-response"},{"title":"Erase a respondent","openapi":"api-reference/openapi.json POST /responses/erase","href":"/developers/api/reference/erase-respondent"},{"title":"Erase a contact","openapi":"api-reference/openapi.json POST /contacts/{contactId}/erase","href":"/developers/api/reference/erase-contact"},{"title":"Get a job","openapi":"api-reference/openapi.json GET /jobs/{jobId}","href":"/developers/api/reference/get-job"}]},{"group":"Metrics","pages":[{"title":"Get summary metrics","openapi":"api-reference/openapi.json GET /metrics/summary","href":"/developers/api/reference/get-metrics-summary"},{"title":"Get a metric over time","openapi":"api-reference/openapi.json GET /metrics/timeseries","href":"/developers/api/reference/get-metrics-time-series"},{"title":"Get a breakdown","openapi":"api-reference/openapi.json GET /metrics/breakdown","href":"/developers/api/reference/get-metrics-breakdown"},{"title":"Get a survey's results per question","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/results","href":"/developers/api/reference/get-survey-results"}]},{"group":"Exports","pages":[{"title":"Start an export","openapi":"api-reference/openapi.json POST /exports","href":"/developers/api/reference/create-export"},{"title":"Get an export","openapi":"api-reference/openapi.json GET /exports/{exportId}","href":"/developers/api/reference/get-export"},{"title":"Download an export's file","openapi":"api-reference/openapi.json GET /exports/{exportId}/download","href":"/developers/api/reference/download-export"}]},{"group":"Contacts","pages":[{"title":"List contacts","openapi":"api-reference/openapi.json GET /contacts","href":"/developers/api/reference/list-contacts"},{"title":"Get a contact","openapi":"api-reference/openapi.json GET /contacts/{contactId}","href":"/developers/api/reference/get-contact"},{"title":"Create a contact","openapi":"api-reference/openapi.json POST /contacts","href":"/developers/api/reference/create-contact"},{"title":"Update a contact","openapi":"api-reference/openapi.json PATCH /contacts/{contactId}","href":"/developers/api/reference/update-contact"},{"title":"Delete a contact","openapi":"api-reference/openapi.json DELETE /contacts/{contactId}","href":"/developers/api/reference/delete-contact"}]},{"group":"Contact lists","pages":[{"title":"List contact lists","openapi":"api-reference/openapi.json GET /contacts/lists","href":"/developers/api/reference/list-contact-lists"},{"title":"Get a contact list","openapi":"api-reference/openapi.json GET /contacts/lists/{listId}","href":"/developers/api/reference/get-contact-list"},{"title":"Create a contact list","openapi":"api-reference/openapi.json POST /contacts/lists","href":"/developers/api/reference/create-contact-list"},{"title":"Update a contact list","openapi":"api-reference/openapi.json PATCH /contacts/lists/{listId}","href":"/developers/api/reference/update-contact-list"},{"title":"Delete a contact list","openapi":"api-reference/openapi.json DELETE /contacts/lists/{listId}","href":"/developers/api/reference/delete-contact-list"},{"title":"List a list's contacts","openapi":"api-reference/openapi.json GET /contacts/lists/{listId}/members","href":"/developers/api/reference/list-contact-list-members"},{"title":"Add contacts to a list","openapi":"api-reference/openapi.json POST /contacts/lists/{listId}/members","href":"/developers/api/reference/add-contact-list-members"},{"title":"Remove contacts from a list","openapi":"api-reference/openapi.json POST /contacts/lists/{listId}/members/remove","href":"/developers/api/reference/remove-contact-list-members"}]},{"group":"Email sends","pages":[{"title":"List email sends","openapi":"api-reference/openapi.json GET /email/sends","href":"/developers/api/reference/list-email-sends"},{"title":"Get an email send","openapi":"api-reference/openapi.json GET /email/sends/{sendId}","href":"/developers/api/reference/get-email-send"},{"title":"List a send's recipients","openapi":"api-reference/openapi.json GET /email/sends/{sendId}/recipients","href":"/developers/api/reference/list-email-send-recipients"},{"title":"Count a send's recipients","openapi":"api-reference/openapi.json GET /email/sends/{sendId}/recipients/summary","href":"/developers/api/reference/get-email-send-recipient-summary"}]},{"group":"Dashboards","pages":[{"title":"Dashboard draft guide","openapi":"api-reference/openapi.json GET /dashboards/capabilities","href":"/developers/api/reference/get-dashboard-capabilities"},{"title":"List dashboards","openapi":"api-reference/openapi.json GET /dashboards","href":"/developers/api/reference/list-dashboards"},{"title":"Get a dashboard","openapi":"api-reference/openapi.json GET /dashboards/{dashboardId}","href":"/developers/api/reference/get-dashboard"},{"title":"Get a dashboard draft","openapi":"api-reference/openapi.json GET /dashboards/{dashboardId}/draft","href":"/developers/api/reference/get-dashboard-draft"},{"title":"Create a dashboard draft","openapi":"api-reference/openapi.json POST /dashboards","href":"/developers/api/reference/create-dashboard"},{"title":"Edit a dashboard draft","openapi":"api-reference/openapi.json PATCH /dashboards/{dashboardId}/draft","href":"/developers/api/reference/edit-dashboard-draft"}]},{"group":"Workflows","pages":[{"title":"Workflow draft guide","openapi":"api-reference/openapi.json GET /workflows/capabilities","href":"/developers/api/reference/get-workflow-capabilities"},{"title":"List workflows","openapi":"api-reference/openapi.json GET /workflows","href":"/developers/api/reference/list-workflows"},{"title":"Get a workflow","openapi":"api-reference/openapi.json GET /workflows/{workflowId}","href":"/developers/api/reference/get-workflow"},{"title":"Create a workflow draft","openapi":"api-reference/openapi.json POST /workflows","href":"/developers/api/reference/create-workflow"},{"title":"Edit a workflow draft","openapi":"api-reference/openapi.json PATCH /workflows/{workflowId}/draft","href":"/developers/api/reference/edit-workflow-draft"},{"title":"List a workflow's runs","openapi":"api-reference/openapi.json GET /workflows/{workflowId}/runs","href":"/developers/api/reference/list-workflow-runs"},{"title":"Get a workflow run","openapi":"api-reference/openapi.json GET /workflows/runs/{runId}","href":"/developers/api/reference/get-workflow-run"}]},{"group":"Support tickets","pages":[{"title":"List your support tickets","openapi":"api-reference/openapi.json GET /support/tickets","href":"/developers/api/reference/list-support-tickets"},{"title":"Get a support ticket","openapi":"api-reference/openapi.json GET /support/tickets/{ticketId}","href":"/developers/api/reference/get-support-ticket"},{"title":"Open a support ticket","openapi":"api-reference/openapi.json POST /support/tickets","href":"/developers/api/reference/create-support-ticket"},{"title":"Reply on a support ticket","openapi":"api-reference/openapi.json POST /support/tickets/{ticketId}/messages","href":"/developers/api/reference/reply-support-ticket"}]},{"group":"Webhook subscriptions","pages":[{"title":"List subscriptions","openapi":"api-reference/openapi.json GET /webhooks","href":"/developers/api/reference/list-webhooks"},{"title":"Subscribe a URL","openapi":"api-reference/openapi.json POST /webhooks/subscribe","href":"/developers/api/reference/subscribe-webhook"},{"title":"List workflow Zapier steps","openapi":"api-reference/openapi.json GET /workflows/zapier-steps","href":"/developers/api/reference/list-zapier-steps"},{"title":"Unsubscribe a URL","openapi":"api-reference/openapi.json DELETE /webhooks/{webhookId}","href":"/developers/api/reference/unsubscribe-webhook"},{"title":"List deliveries","openapi":"api-reference/openapi.json GET /webhooks/{webhookId}/deliveries","href":"/developers/api/reference/list-deliveries"},{"title":"Resend a delivery","openapi":"api-reference/openapi.json POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/developers/api/reference/resend-delivery"}]},{"group":"Webhook events","pages":[{"title":"response.created","openapi":"api-reference/openapi.json webhook response.created","href":"/developers/api/reference/webhook-response-created"},{"title":"response.analyzed","openapi":"api-reference/openapi.json webhook response.analyzed","href":"/developers/api/reference/webhook-response-analyzed"},{"title":"response.status_changed","openapi":"api-reference/openapi.json webhook response.status_changed","href":"/developers/api/reference/webhook-response-status-changed"},{"title":"response.classification_corrected","openapi":"api-reference/openapi.json webhook response.classification_corrected","href":"/developers/api/reference/webhook-response-classification-corrected"},{"title":"response.urgent","openapi":"api-reference/openapi.json webhook response.urgent","href":"/developers/api/reference/webhook-response-urgent"},{"title":"theme.spiking","openapi":"api-reference/openapi.json webhook theme.spiking","href":"/developers/api/reference/webhook-theme-spiking"}]}]},{"group":"Webhooks","icon":"webhook","root":{"title":"Webhooks","sidebarTitle":"Overview","href":"/developers/webhooks/overview"},"directory":"card","pages":[{"title":"Webhook events","href":"/developers/webhooks/events"},{"title":"Verify signatures","href":"/developers/webhooks/verify"},{"title":"Delivery and retries","href":"/developers/webhooks/delivery"},{"title":"Rotate a secret","href":"/developers/webhooks/rotation"}]},{"group":"MCP","icon":"bot","pages":[{"title":"MCP server","href":"/developers/mcp"}]}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create a survey draft - Usertick","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}