Adds an internal (team-only) comment to the thread, as the acting user,
the same as commenting in the app. It is never sent to the contact.
content is HTML and is sanitized. Mention markup in it labels the
thread for the mentioned users and teams, marks it unread for them and
notifies them. Mentioned contacts and location cards are related to the
thread.
The acting user is the delegate token’s own user. With an API key or
partner token, name one in userId. Guests cannot comment.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aptly API","colors":{"primary":"#0066FF"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aptly-10a57313","hasAudioNarration":false,"actualSubdomain":"aptly-10a57313","customDomains":["docs.getaptly.com"],"gitSource":{"type":"github","owner":"workturbo","repo":"core-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab","collectionId":"1788173d-2862-4418-873a-da2b64e83176","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4dfc987cb31e1fa2cb0ab"},"feedback":{"agentFeedback":true},"entitlements":{},"buildId":"6aee14921358265f252884b3","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":210},{"language":"default","tag":"Board","count":29},{"language":"default","tag":"Documentation","count":17},{"language":"default","tag":"Inboxes","count":15},{"language":"default","tag":"Aptly Portal","count":14},{"language":"default","tag":"Contacts","count":10},{"language":"default","tag":"Cards","count":9},{"language":"default","tag":"Knowledge","count":8},{"language":"default","tag":"Getting Started","count":7},{"language":"default","tag":"Context \u0026 Locations","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/inboxes/add-an-internal-comment-to-a-thread","slug":"/api-reference/inboxes/add-an-internal-comment-to-a-thread","pageMetadata":{"title":"Add an internal comment to a thread","description":"Adds an internal (team-only) comment to the thread, as the acting user,\nthe same as commenting in the app. It is never sent to the contact.\n`content` is HTML and is sanitized. Mention markup in it labels the\nthread for the mentioned users and teams, marks it unread for them and\nnotifies them. Mentioned contacts and location cards are related to the\nthread.\n\nThe acting user is the delegate token's own user. With an API key or\npartner token, name one in `userId`. Guests cannot comment.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/comments","href":"/api-reference/inboxes/add-an-internal-comment-to-a-thread","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Adds an internal (team-only) comment to the thread, as the acting user,\\nthe same as commenting in the app. It is never sent to the contact.\\n\", _jsx(_components.code, {\n children: \"content\"\n }), \" is HTML and is sanitized. Mention markup in it labels the\\nthread for the mentioned users and teams, marks it unread for them and\\nnotifies them. Mentioned contacts and location cards are related to the\\nthread.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The acting user is the delegate token’s own user. With an API key or\\npartner token, name one in \", _jsx(_components.code, {\n children: \"userId\"\n }), \". Guests cannot comment.\"]\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 an internal comment to a thread","description":"Adds an internal (team-only) comment to the thread, as the acting user,\nthe same as commenting in the app. It is never sent to the contact.\n`content` is HTML and is sanitized. Mention markup in it labels the\nthread for the mentioned users and teams, marks it unread for them and\nnotifies them. Mentioned contacts and location cards are related to the\nthread.\n\nThe acting user is the delegate token's own user. With an API key or\npartner token, name one in `userId`. Guests cannot comment.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/comments","href":"/api-reference/inboxes/add-an-internal-comment-to-a-thread","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Add an internal comment to a thread","description":"Adds an internal (team-only) comment to the thread, as the acting user,\nthe same as commenting in the app. It is never sent to the contact.\n`content` is HTML and is sanitized. Mention markup in it labels the\nthread for the mentioned users and teams, marks it unread for them and\nnotifies them. Mentioned contacts and location cards are related to the\nthread.\n\nThe acting user is the delegate token's own user. With an API key or\npartner token, name one in `userId`. Guests cannot comment.\n","operationId":"addInboxThreadComment","tags":["Inboxes"],"security":["00ad0ff5-4b6d-45b9-bb25-dcc363d1ad5b","b3677cb2-8377-4593-9a8c-982414070ac8","902a5bbc-8f38-4ada-b31a-6c0f53febffd"],"parameters":["eb50d704-4932-41db-b41a-5b03a6e1601e","f70b3821-6fbc-4846-b2ea-0f2e3d355d03"],"requestBody":"9f7cb2e3-4226-4523-9078-94196fd6805f","responses":{"201":"5a86e52d-e45c-492e-b38c-52c1a286e4b4","400":"41ada546-6b61-42a3-b070-4113b8add01d","401":"7f041704-cbbe-4669-b01c-9d1cb085de77","403":"31571690-78b6-46ca-9086-618ed57bffcd","404":"6843ef01-9177-4158-82ac-b750c231f620"},"method":"post","type":"path","servers":["2c09e663-c361-4d47-8603-42828df6b66a"],"path":"/api/inboxes/{channelId}/threads/{threadId}/comments","baseUrlOptions":["https://core-api.getaptly.com"],"title":"Add an internal comment to a thread","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eb50d704-4932-41db-b41a-5b03a6e1601e":{"name":"channelId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"External channel meta ID (`meta.id`) of the inbox.","uniqueKey":"","typeLabel":"string"},"description":"External channel meta ID (`meta.id`) of the inbox."},"f70b3821-6fbc-4846-b2ea-0f2e3d355d03":{"name":"threadId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Thread id from the threads list.","uniqueKey":"","typeLabel":"string"},"description":"Thread id from the threads list."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["content"],"properties":{"content":{"type":"string","minLength":1,"maxLength":50000,"description":"Comment body, HTML.","isRequired":true,"uniqueKey":"content","typeLabel":"string"},"userId":{"type":"string","description":"Acting user (comment author). Required with an API key or partner token.","uniqueKey":"userId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"content":"\u003cstring>","userId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5a86e52d-e45c-492e-b38c-52c1a286e4b4":{"description":"Comment added.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"threadId":{"type":"string","uniqueKey":"data.threadId","typeLabel":"string"},"commentId":{"type":"string","uniqueKey":"data.commentId","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"threadId":"\u003cstring>","commentId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"41ada546-6b61-42a3-b070-4113b8add01d":{"description":"Invalid body or missing `userId`.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7f041704-cbbe-4669-b01c-9d1cb085de77":{"description":"The acting user is not in the company.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"31571690-78b6-46ca-9086-618ed57bffcd":{"description":"No access to this inbox, or the acting user is a guest.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"6843ef01-9177-4158-82ac-b750c231f620":{"description":"Inbox or thread not found, or the acting user cannot see the thread.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"00ad0ff5-4b6d-45b9-bb25-dcc363d1ad5b":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"}},"b3677cb2-8377-4593-9a8c-982414070ac8":{"DelegateToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"}},"902a5bbc-8f38-4ada-b31a-6c0f53febffd":{"PartnerBearer":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"}}},"servers":{"2c09e663-c361-4d47-8603-42828df6b66a":{"url":"https://core-api.getaptly.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-token","scopes":[],"schemeName":"ApiKeyHeader"},"schema":{"title":"x-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyHeader","name":"x-token"}],"title":"ApiKeyHeader"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","scopes":[],"schemeName":"DelegateToken"},"schema":{"title":"Authorization","type":"string","description":"Delegate token issued by the platform. Format: `DelegateToken \u003ctoken>`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"DelegateToken","name":"Authorization"}],"title":"DelegateToken"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","scopes":[],"schemeName":"PartnerBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner token. Format: `Authorization: Bearer \u003ctoken>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerBearer","name":"Authorization"}],"title":"PartnerBearer"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"aptly-10a57313","siteName":"Aptly API","title":"Add an internal comment to a thread - Aptly API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T17:55:36.762Z","originalFileLocation":"api-reference/inboxes/add-an-internal-comment-to-a-thread.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 an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread. The acting user is the delegate token\u0026#x27;s own user. With an API key or partner token, name one in userId. Guests cannot comment.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add an internal comment to a thread - Aptly API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread. The acting user is the delegate token\u0026#x27;s own user. With an API key or partner token, name one in userId. Guests cannot comment.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aptly API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aptly-10a57313.mintlify.site/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Add+an+internal+comment+to+a+thread\u0026amp;description=Adds+an+internal+%28team-only%29+comment+to+the+thread%2C+as+the+acting+user%2C%0Athe+same+as+commenting+in+the+app.+It+is+never+sent+to+the+contact.%0A%60content%60+is+HTML+an\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=7aabaf036db80508426a7866c2b86072aed98d7ad78667df18fbf1ccb857ebf2\">\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 an internal comment to a thread - Aptly API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread. The acting user is the delegate token\u0026#x27;s own user. With an API key or partner token, name one in userId. Guests cannot comment.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aptly-10a57313.mintlify.site/_mintlify/api/og/v2?division=Inboxes\u0026amp;title=Add+an+internal+comment+to+a+thread\u0026amp;description=Adds+an+internal+%28team-only%29+comment+to+the+thread%2C+as+the+acting+user%2C%0Athe+same+as+commenting+in+the+app.+It+is+never+sent+to+the+contact.%0A%60content%60+is+HTML+an\u0026amp;theme=2df7969a14dd47f616338bb6\u0026amp;signature=7aabaf036db80508426a7866c2b86072aed98d7ad78667df18fbf1ccb857ebf2\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/aptly-10a57313/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aptly API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/inboxes/add-an-internal-comment-to-a-thread.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getaptly.com/#organization\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getaptly.com#website\",\"name\":\"Aptly API\",\"url\":\"https://docs.getaptly.com\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread#webpage\",\"url\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread\",\"name\":\"Add an internal comment to a thread\",\"description\":\"Adds an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread. The acting user is the delegate token's own user. With an API key or partner token, name one in userId. Guests cannot comment.\",\"dateModified\":\"2026-11-06T17:55:36.762Z\",\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.getaptly.com/api-reference/users/list-users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inboxes\",\"item\":\"https://docs.getaptly.com/api-reference/inboxes/list-inboxes-you-can-query\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add an internal comment to a thread\",\"item\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread#apireference\",\"headline\":\"Add an internal comment to a thread\",\"name\":\"Add an internal comment to a thread\",\"description\":\"Adds an internal (team-only) comment to the thread, as the acting user, the same as commenting in the app. It is never sent to the contact. content is HTML and is sanitized. Mention markup in it labels the thread for the mentioned users and teams, marks it unread for them and notifies them. Mentioned contacts and location cards are related to the thread. The acting user is the delegate token's own user. With an API key or partner token, name one in userId. Guests cannot comment.\",\"url\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getaptly.com/api-reference/inboxes/add-an-internal-comment-to-a-thread#webpage\"},\"dateModified\":\"2026-11-06T17:55:36.762Z\",\"publisher\":{\"@id\":\"https://docs.getaptly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getaptly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aptly API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aptly API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users","href":"/api-reference/users/list-users"},{"title":"List a user's email inboxes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/users/{userId}/inboxes","href":"/api-reference/users/list-a-users-email-inboxes"}]},{"group":"Inboxes","pages":[{"title":"List inboxes you can query","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes","href":"/api-reference/inboxes/list-inboxes-you-can-query"},{"title":"List threads and messages on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/threads","href":"/api-reference/inboxes/list-threads-and-messages-on-an-inbox"},{"title":"List threads and messages on an inbox (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/messages","href":"/api-reference/inboxes/list-threads-and-messages-on-an-inbox-deprecated"},{"title":"Conversation analytics for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/analytics","href":"/api-reference/inboxes/conversation-analytics-for-an-inbox"},{"title":"Activity history for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/history","href":"/api-reference/inboxes/activity-history-for-an-inbox"},{"title":"Get one thread on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/threads/{threadId}","href":"/api-reference/inboxes/get-one-thread-on-an-inbox"},{"title":"Assign or unassign a thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/assign","href":"/api-reference/inboxes/assign-or-unassign-a-thread"},{"title":"Relate a card to a thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/relate-card","href":"/api-reference/inboxes/relate-a-card-to-a-thread"},{"title":"Unrelate a card from a thread","description":"Removes the card's relation to the thread, the reverse of\n`POST .../relate-card`. Same checks, and the card's conversation metrics\nare recalculated. Unrelating a card that isn't related is a no-op.\n\nThe acting user is the delegate token's own user. With an API key or\npartner token, name one in `userId`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/unrelate-card","href":"/api-reference/inboxes/unrelate-a-card-from-a-thread"},{"title":"Add an internal comment to a thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/comments","href":"/api-reference/inboxes/add-an-internal-comment-to-a-thread"},{"title":"Get one email message with its full body and attachments","description":"Returns one email message with its **full** body, fetched live from the\nmail provider (the `body` on the list endpoint is only the stored snippet),\nplus metadata for each attachment. Download an attachment's bytes with the\nattachment endpoint below.\n\n`threadId` and `messageId` are the `threadId` / `messageId` values returned\nby `GET /api/inboxes/{channelId}/threads`. The thread must belong to the\ninbox and the message to the thread. Only email messages are supported;\nother message types return 400.\n\nInline images in an HTML body reference attachments as `cid:\u003ccontentId>`.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/threads/{threadId}/messages/{messageId}","href":"/api-reference/inboxes/get-one-email-message-with-its-full-body-and-attachments"},{"title":"Download an email attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/threads/{threadId}/messages/{messageId}/attachments/{attachmentId}","href":"/api-reference/inboxes/download-an-email-attachment"},{"title":"Volume and response-time trends for an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/trends","href":"/api-reference/inboxes/volume-and-response-time-trends-for-an-inbox"},{"title":"Volume health for an inbox against its own baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/health","href":"/api-reference/inboxes/volume-health-for-an-inbox-against-its-own-baseline"},{"title":"List unsent drafts on an inbox","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/inboxes/{channelId}/drafts","href":"/api-reference/inboxes/list-unsent-drafts-on-an-inbox"}]},{"group":"Schema","pages":[{"title":"Get board schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/schema/{boardId}","href":"/api-reference/schema/get-board-schema"}]},{"group":"Boards","pages":[{"title":"List boards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/boards","href":"/api-reference/boards/list-boards"},{"title":"Create a board","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/boards","href":"/api-reference/boards/create-a-board"}]},{"group":"Cards","pages":[{"title":"List cards","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/list","href":"/api-reference/cards/list-cards"},{"title":"List cards (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}","href":"/api-reference/cards/list-cards-deprecated"},{"title":"Create or update a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}","href":"/api-reference/cards/create-or-update-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}","href":"/api-reference/cards/get-a-card"},{"title":"Archive a card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/{cardId}","href":"/api-reference/cards/archive-a-card"},{"title":"List comments on a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/comments","href":"/api-reference/cards/list-comments-on-a-card"},{"title":"List contacts linked to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/{cardId}/contacts","href":"/api-reference/cards/list-contacts-linked-to-a-card"},{"title":"Add or update a comment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/comment","href":"/api-reference/cards/add-or-update-a-comment"},{"title":"Upload a file to a card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/{cardId}/file","href":"/api-reference/cards/upload-a-file-to-a-card"}]},{"group":"Board","pages":[{"title":"Archive a board","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}","href":"/api-reference/board/archive-a-board"},{"title":"List merge fields for a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/merge-fields","href":"/api-reference/board/list-merge-fields-for-a-board"},{"title":"List users who can open a board","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/users","href":"/api-reference/board/list-users-who-can-open-a-board"},{"title":"Get a board's activity feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/activity","href":"/api-reference/board/get-a-boards-activity-feed"},{"title":"Add a tab view","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/tabViews","href":"/api-reference/board/add-a-tab-view"},{"title":"Add a tab view (legacy)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/tabView","href":"/api-reference/board/add-a-tab-view-legacy"},{"title":"Verify a delegate token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/verify-user","href":"/api-reference/board/verify-a-delegate-token"},{"title":"Set or update the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/webhook","href":"/api-reference/board/set-or-update-the-boards-webhook"},{"title":"Remove the board's webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/webhook","href":"/api-reference/board/remove-the-boards-webhook"},{"title":"Get full board configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration","href":"/api-reference/board/get-full-board-configuration"},{"title":"List board automations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/automations","href":"/api-reference/board/list-board-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/automations","href":"/api-reference/board/create-an-automation"},{"title":"List create-card rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/card-rules","href":"/api-reference/board/list-create-card-rules"},{"title":"Get board options","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/options","href":"/api-reference/board/get-board-options"},{"title":"List board fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/fields","href":"/api-reference/board/list-board-fields"},{"title":"Add a field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/fields","href":"/api-reference/board/add-a-field"},{"title":"Add a mirror field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/mirror-fields","href":"/api-reference/board/add-a-mirror-field"},{"title":"Update a field","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/board/{boardId}/configuration/fields/{fieldUuid}","href":"/api-reference/board/delete-a-field"},{"title":"Reorder fields","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/field-order","href":"/api-reference/board/reorder-fields"},{"title":"List board field groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/groups","href":"/api-reference/board/list-board-field-groups"},{"title":"Create a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/board/{boardId}/configuration/groups","href":"/api-reference/board/create-a-field-group"},{"title":"Update a field group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/groups/{groupUuid}","href":"/api-reference/board/update-a-field-group"},{"title":"Get the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/get-the-create-card-form-order"},{"title":"Set the create-card form order","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/board/{boardId}/configuration/start-card-order","href":"/api-reference/board/set-the-create-card-form-order"},{"title":"Get board access settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/shares","href":"/api-reference/board/get-board-access-settings"},{"title":"Get board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/theme","href":"/api-reference/board/get-board-identity-fields"},{"title":"Update board identity fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/board/{boardId}/configuration/theme","href":"/api-reference/board/update-board-identity-fields"},{"title":"List board filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/board/{boardId}/configuration/filters","href":"/api-reference/board/list-board-filters"}]},{"group":"Company","pages":[{"title":"Get company info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/company/info","href":"/api-reference/company/get-company-info"}]},{"group":"Contacts","pages":[{"title":"Get conversations for contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/conversations","href":"/api-reference/contacts/get-conversations-for-contacts"},{"title":"Get contact conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/conversations","href":"/api-reference/contacts/get-contact-conversations"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Look up contacts by email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/by-email","href":"/api-reference/contacts/look-up-contacts-by-email"},{"title":"Initiate contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email","href":"/api-reference/contacts/initiate-contact-email-verification"},{"title":"Confirm contact email verification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/verify-email/{requestId}/confirm","href":"/api-reference/contacts/confirm-contact-email-verification"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/contacts/{contactId}","href":"/api-reference/contacts/update-a-contact"},{"title":"Get a contact's sentiment history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/contacts/{contactId}/sentiment","href":"/api-reference/contacts/get-a-contacts-sentiment-history"}]},{"group":"Knowledge","pages":[{"title":"Create a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/knowledge/create","href":"/api-reference/knowledge/create-a-knowledge-document"},{"title":"List knowledge documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/list","href":"/api-reference/knowledge/list-knowledge-documents"},{"title":"Get the knowledge document tree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/tree","href":"/api-reference/knowledge/get-the-knowledge-document-tree"},{"title":"List a knowledge document's direct children","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/children","href":"/api-reference/knowledge/list-a-knowledge-documents-direct-children"},{"title":"List saved knowledge document versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history","href":"/api-reference/knowledge/list-saved-knowledge-document-versions"},{"title":"Read a saved knowledge document version","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}/history/{versionId}","href":"/api-reference/knowledge/read-a-saved-knowledge-document-version"},{"title":"Get a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/knowledge/{id}","href":"/api-reference/knowledge/get-a-knowledge-document"},{"title":"Update a knowledge document","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/knowledge/{id}","href":"/api-reference/knowledge/update-a-knowledge-document"}]},{"group":"Email","pages":[{"title":"Create an email draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/create-draft","href":"/api-reference/email/create-an-email-draft"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/email/send","href":"/api-reference/email/send-an-email"}]},{"group":"App","pages":[{"title":"Verify a delegate token (keyless)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/app/verify","href":"/api-reference/app/verify-a-delegate-token-keyless"},{"title":"Get credential info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/app/me","href":"/api-reference/app/get-credential-info"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates","href":"/api-reference/templates/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/templates","href":"/api-reference/templates/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/templates/{id}","href":"/api-reference/templates/get-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/templates/{id}","href":"/api-reference/templates/update-a-template"}]},{"group":"Tasks","pages":[{"title":"Search tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/search","href":"/api-reference/tasks/search-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Update many tasks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/tasks/bulk-update","href":"/api-reference/tasks/update-many-tasks"},{"title":"Get a task by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tasks/{taskId}","href":"/api-reference/tasks/get-a-task-by-id"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/tasks/{taskId}","href":"/api-reference/tasks/update-a-task"}]},{"group":"RoutingGroups","pages":[{"title":"List routing groups","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/routing-groups","href":"/api-reference/routinggroups/list-routing-groups"},{"title":"Create a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/create","href":"/api-reference/routinggroups/create-a-routing-group"},{"title":"Update a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml put /api/routing-groups/{id}","href":"/api-reference/routinggroups/update-a-routing-group"},{"title":"Archive a routing group","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/routing-groups/{id}/archive","href":"/api-reference/routinggroups/archive-a-routing-group"}]},{"group":"Files","pages":[{"title":"Get a presigned URL for a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-url","href":"/api-reference/files/get-a-presigned-url-for-a-direct-file-upload"},{"title":"Finalize a direct file upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/files/upload-complete","href":"/api-reference/files/finalize-a-direct-file-upload"}]},{"group":"WebForms","pages":[{"title":"Submit a web form","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/web-forms/{formId}","href":"/api-reference/webforms/submit-a-web-form"}]},{"group":"Tours","pages":[{"title":"List tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/feedback","href":"/api-reference/tours/list-tour-feedback"},{"title":"Get one showing's tour feedback","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/tours/{showingId}/feedback","href":"/api-reference/tours/get-one-showings-tour-feedback"}]},{"group":"Docs","pages":[{"title":"Fetch this OpenAPI spec","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/docs/openapi","href":"/api-reference/docs/fetch-this-openapi-spec"}]}]}]},{"tab":"Aptly Portal","icon":"door-closed","pages":[{"title":"Aptly Portal","href":"/portal/introduction"}]}]},"basePath":"","title":"Add an internal comment to a thread - Aptly API","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}