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.
{"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"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open dashboard","href":"https://app.usertick.com"}},"footer":{"socials":{"website":"https://usertick.com"}},"icons":{"library":"lucide"},"styling":{"latex":true},"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":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae09581f01d62d5339237c5","collectionId":"0371a23d-9f7c-4f98-b020-39f01fefbc89","liveDeploymentHistoryId":"6ae09581f01d62d5339237c5","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae5c62997d8304171747d14","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Developers","count":56},{"language":"default","tag":"Documentation","count":44},{"language":"default","tag":"API reference","count":35},{"language":"default","tag":"Integrations","count":24},{"language":"default","tag":"REST API","count":12},{"language":"default","tag":"Build surveys","count":9},{"language":"default","tag":"Account","count":8},{"language":"default","tag":"Responses","count":7},{"language":"default","tag":"Install Usertick","count":7},{"language":"default","tag":"Webhook subscriptions","count":6}],"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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developers/api/reference/add-comment","slug":"/developers/api/reference/add-comment","pageMetadata":{"title":"Add a note","openapi":"api-reference/openapi.json POST /responses/{responseId}/comments","description":"Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name.\n\nScopes: responses:write.","href":"/developers/api/reference/add-comment"},"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: \"Adds a note as the credential: an app’s note is its member’s, an API key’s note carries the key’s name.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Scopes: responses:write.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add a note","openapi":"api-reference/openapi.json POST /responses/{responseId}/comments","description":"Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name.\n\nScopes: responses:write.","href":"/developers/api/reference/add-comment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"addComment","summary":"Add a note","description":"Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name.\n\nScopes: responses:write.","tags":["Responses"],"x-scopes":["responses:write"],"parameters":["54ef5cb3-e402-4a16-adc7-897fbf644db4","cb7e5f21-561f-4737-ac42-97e597d1066a"],"requestBody":"79ad5871-74e5-44b4-a6f1-cb87fbbc50e8","responses":{"201":"3df1ba59-5552-4038-9e13-1fdeba6250fa","400":"76c3797e-ac0a-4e5a-af9e-8520faa2bc37","401":"e1105056-d64d-4110-9c2c-56aa3b980750","403":"7c3e0115-46a0-486e-a7bf-95896b97d863","404":"aa9a1fc5-fa06-4acf-ac7a-b08da4cea331","409":"e4082e2f-d609-4d13-98f7-a512322d8d96","413":"c0c5dc43-296f-4633-a09b-cd3c4bd3181e","429":"4f3b5835-8c97-4b5c-916d-aca8c378d2b6"},"method":"post","type":"path","servers":["1243191b-4fd0-4b4b-bffe-f8a7fd8119a9"],"security":["3a3e4305-85c4-459a-ba96-4b4e71fcd545","34a73146-0ccb-4780-9fd8-6624fbb3dcc4"],"path":"/responses/{responseId}/comments","baseUrlOptions":["https://app.usertick.com/api/public/v1"],"title":"Add a note","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"54ef5cb3-e402-4a16-adc7-897fbf644db4":{"name":"responseId","in":"path","description":"A response id.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"A response id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"cb7e5f21-561f-4737-ac42-97e597d1066a":{"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":{"body":{"type":"string","minLength":1,"maxLength":10000,"isRequired":true,"uniqueKey":"body","typeLabel":"string"}},"required":["body"],"additionalProperties":false,"examples":[{"body":"Fixed in 2.4.1."}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"body":"Fixed in 2.4.1."}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3df1ba59-5552-4038-9e13-1fdeba6250fa":{"description":"The note.","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"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"responseId":{"type":"string","isRequired":true,"uniqueKey":"responseId","typeLabel":"string"},"kind":{"type":"string","enum":["note","external"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"body":{"type":"string","description":"Markdown.","isRequired":true,"uniqueKey":"body","typeLabel":"string"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["member","api_key","external"],"isRequired":true,"uniqueKey":"author.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"author.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"author.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"author.id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"author.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"author.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"author.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"author.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"author.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"author.email","typeLabel":"string | null"}},"required":["type","id","name","email"],"additionalProperties":false,"isRequired":true,"uniqueKey":"author","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"editedAt":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"editedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"editedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"editedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","responseId","kind","body","author","createdAt","editedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","responseId":"\u003cstring>","kind":"note","body":"\u003cstring>","author":{"type":"member","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","email":"\u003cstring>"},"createdAt":"2026-09-30T10:00:00.000Z","editedAt":"2026-09-30T10:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"76c3797e-ac0a-4e5a-af9e-8520faa2bc37":{"description":"The request isn't valid. Codes: RSP-002-002, RSP-002-003, PUB-001-006, 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"}}},"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":{"RSP-002-002":{"title":"RSP-002-002","value":{"statusCode":400,"success":false,"code":"RSP-002-002","message":"The note can't be empty.","data":null}},"RSP-002-003":{"title":"RSP-002-003","value":{"statusCode":400,"success":false,"code":"RSP-002-003","message":"The note is too long.","data":null}},"PUB-001-006":{"title":"PUB-001-006","value":{"statusCode":400,"success":false,"code":"PUB-001-006","message":"Send a JSON body that this endpoint accepts.","data":null}},"PUB-002-001":{"title":"PUB-002-001","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"},"e1105056-d64d-4110-9c2c-56aa3b980750":{"description":"No credential, or one that is invalid, expired or revoked. Codes: APK-004-001, APK-004-002.","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","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","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}}},"exampleType":"examples"}},"exampleType":"examples"},"7c3e0115-46a0-486e-a7bf-95896b97d863":{"description":"The credential lacks a scope this endpoint needs, the plan does not include the API (API keys on Pro and up, apps such as Zapier on Starter and up), or an app's member lacks the permission. Codes: APK-004-004, APK-004-005, APK-004-008, AUTHZ-001-002.","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","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","value":{"statusCode":403,"success":false,"code":"APK-004-005","message":"Your plan doesn't include API keys or the MCP server. To use them, upgrade to Pro or higher.","data":null}},"APK-004-008":{"title":"APK-004-008","value":{"statusCode":403,"success":false,"code":"APK-004-008","message":"Your plan doesn't include apps that use the API, such as Zapier. To use them, upgrade to Starter or higher.","data":null}},"AUTHZ-001-002":{"title":"AUTHZ-001-002","value":{"statusCode":403,"success":false,"code":"AUTHZ-001-002","message":"Your role doesn't have the required permission.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"aa9a1fc5-fa06-4acf-ac7a-b08da4cea331":{"description":"The resource couldn't be found. Codes: RSP-002-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":{"RSP-002-007":{"title":"RSP-002-007","value":{"statusCode":404,"success":false,"code":"RSP-002-007","message":"The response couldn't be found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"e4082e2f-d609-4d13-98f7-a512322d8d96":{"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.","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","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","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"},"c0c5dc43-296f-4633-a09b-cd3c4bd3181e":{"description":"The body is over 64 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","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"},"4f3b5835-8c97-4b5c-916d-aca8c378d2b6":{"description":"Over the credential's or the organization's budget, or over the per-address limit that is checked before the credential (GEN-429-001, without X-RateLimit headers). Codes: APK-004-003, APK-004-006, GEN-429-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"}},"Retry-After":{"description":"Seconds to wait before trying again.","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","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","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","value":{"statusCode":429,"success":false,"code":"GEN-429-001","message":"Too many requests were sent. Wait a minute and try again.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3a3e4305-85c4-459a-ba96-4b4e71fcd545":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"}},"34a73146-0ccb-4780-9fd8-6624fbb3dcc4":{"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"}}},"servers":{"1243191b-4fd0-4b4b-bffe-f8a7fd8119a9":{"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":"Add a note - Usertick","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T06:32:59.197Z","originalFileLocation":"developers/api/reference/add-comment.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=\"Adds a note as the credential: an app\u0026#x27;s note is its member\u0026#x27;s, an API key\u0026#x27;s note carries the key\u0026#x27;s name. Scopes: responses:write.\">\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=\"Add a note - Usertick\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a note as the credential: an app\u0026#x27;s note is its member\u0026#x27;s, an API key\u0026#x27;s note carries the key\u0026#x27;s name. Scopes: responses:write.\">\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/add-comment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://usertick.mintlify.app/_mintlify/api/og/v2?division=Notes\u0026amp;title=Add+a+note\u0026amp;description=Adds+a+note+as+the+credential%3A+an+app%27s+note+is+its+member%27s%2C+an+API+key%27s+note+carries+the+key%27s+name.%0A%0AScopes%3A+responses%3Awrite.\u0026amp;theme=47d2035b061bb461b6b02c51\u0026amp;signature=9a470ae5a0873a1bd1d37dc3c97aa1a5a5dfe6910abdb09ca9b54a345a4d4934\">\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=\"Add a note - Usertick\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a note as the credential: an app\u0026#x27;s note is its member\u0026#x27;s, an API key\u0026#x27;s note carries the key\u0026#x27;s name. Scopes: responses:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://usertick.mintlify.app/_mintlify/api/og/v2?division=Notes\u0026amp;title=Add+a+note\u0026amp;description=Adds+a+note+as+the+credential%3A+an+app%27s+note+is+its+member%27s%2C+an+API+key%27s+note+carries+the+key%27s+name.%0A%0AScopes%3A+responses%3Awrite.\u0026amp;theme=47d2035b061bb461b6b02c51\u0026amp;signature=9a470ae5a0873a1bd1d37dc3c97aa1a5a5dfe6910abdb09ca9b54a345a4d4934\">\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/add-comment\">\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/add-comment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usertick.com/#organization\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/light.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=9461af4bcd4a352017accf4accb120f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usertick.com#website\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"publisher\":{\"@id\":\"https://docs.usertick.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usertick.com/developers/api/reference/add-comment#webpage\",\"url\":\"https://docs.usertick.com/developers/api/reference/add-comment\",\"name\":\"Add a note\",\"description\":\"Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name. Scopes: responses:write.\",\"dateModified\":\"2026-10-24T06:32:59.197Z\",\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/add-comment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usertick.com/developers/api/reference/add-comment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Notes\",\"item\":\"https://docs.usertick.com/developers/api/reference/list-comments\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add a note\",\"item\":\"https://docs.usertick.com/developers/api/reference/add-comment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usertick.com/developers/api/reference/add-comment#apireference\",\"headline\":\"Add a note\",\"name\":\"Add a note\",\"description\":\"Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name. Scopes: responses:write.\",\"url\":\"https://docs.usertick.com/developers/api/reference/add-comment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/add-comment#webpage\"},\"dateModified\":\"2026-10-24T06:32:59.197Z\",\"publisher\":{\"@id\":\"https://docs.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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Usertick","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Developers","groups":[{"group":"JavaScript SDK","pages":[{"title":"JavaScript SDK","sidebarTitle":"Overview","href":"/developers/sdk/overview"},{"title":"SDK reference","href":"/developers/sdk/reference"},{"title":"SDK events","href":"/developers/sdk/events"}]},{"group":"REST API","pages":[{"title":"REST API","sidebarTitle":"Overview","href":"/developers/api/overview"},{"title":"Authentication","href":"/developers/api/authentication"},{"title":"OAuth for apps","href":"/developers/api/oauth"},{"title":"The Response resource","sidebarTitle":"The Response resource","href":"/developers/api/response-object"},{"title":"Pagination","href":"/developers/api/pagination"},{"title":"Errors","href":"/developers/api/errors"},{"title":"Rate limits","href":"/developers/api/rate-limits"},{"title":"Idempotency","href":"/developers/api/idempotency"},{"title":"Versioning","href":"/developers/api/versioning"},{"title":"Erase personal data","href":"/developers/api/erasure"},{"title":"Metrics","href":"/developers/api/metrics"},{"title":"Download files","href":"/developers/api/attachments"}]},{"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":"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":"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","description":"A response's notes, oldest first, deleted ones left out.\n\nScopes: responses:read.","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}","description":"Changes a note the credential wrote (an API key its own notes, an app its member's).\n\nScopes: responses:write.","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":"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"}]},{"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","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/developers/webhooks/overview"},{"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","pages":[{"title":"MCP server","href":"/developers/mcp"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/surveys"}]}]},"basePath":"","title":"Add a note - Usertick","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}