Replace existing clauses in place by clause_id. Position in the clauses list is unchanged.
Show child attributes
remove_clause_ids
string[] | null
Response
Successful Response
collection_id
string
required
name
string
required
clauses
CollectionClause · object[]
required
Show child attributes
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
user_id
string | null
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Channel3","colors":{"primary":"#6F96B5","light":"#6F96B5","dark":"#6F96B5"},"logo":{"light":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-light.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=d23a7735ff07b0e7ad75f84ecffc413e","dark":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-dark.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=2eab753f0c6950d281b85ee099e3ce30"},"favicon":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/favicon.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=3d39bd96ce5d83d11fae9a829b0da744","api":{"examples":{"defaults":"required","languages":["python","javascript","curl"]}},"navbar":{"links":[{"icon":"/logo/discord.svg","href":"https://discord.gg/6J6MjctXrH","label":"Discord"},{"href":"mailto:support@channel3.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://channel3.ai/dashboard"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"gtm":{"tagId":"GTM-WGKVRXL8"},"posthog":{"apiKey":"phc_rgdJvtXC2gguCCcXmacTEvAxuegz0vcgLbcyNQrTRdy","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"channel3","hasAudioNarration":false,"actualSubdomain":"channel3","customDomains":[],"gitSource":{"type":"github","owner":"channel3-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6b00c0d414ebbf8b8d982a7e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":116},{"language":"default","tag":"API Reference","count":53},{"language":"default","tag":"Integrate","count":48},{"language":"default","tag":"Changelog","count":31},{"language":"default","tag":"Release notes","count":24},{"language":"default","tag":"Conversational Agent","count":16},{"language":"default","tag":"SDK","count":16},{"language":"default","tag":"Make a Search","count":15},{"language":"default","tag":"Search","count":13},{"language":"default","tag":"CLI","count":11}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root,.dark{--radius: 4px;--radius-sm: 2px;--radius-md: 4px;--radius-lg: 4px;--radius-xl: 6px;--radius-2xl: 6px;--radius-3xl: 6px}card,tile,callout,accordion,code-block,code-group,frame,expandable,update,tooltip,step{border-radius:4px!important;overflow:hidden}code-group,code-block,pre,figure,[data-component-name=\"code-block\"],[data-component-name=\"code-group\"]{border-radius:4px!important;overflow:hidden}button,[data-component-name=\"primary-header-button\"],input,select,textarea,img{border-radius:4px!important}.rounded,.rounded-sm,.rounded-md,.rounded-lg,.rounded-xl,.rounded-2xl,.rounded-3xl,[class*=\"rounded-[\"]{border-radius:4px!important}#search-bar-entry,#search-bar-entry-mobile,#search-input{border-radius:4px!important}"}]}
{"page":{"pagePath":"api-reference/v1/update-collection","slug":"/api-reference/v1/update-collection","pageMetadata":{"openapi":"patch /v1/collections/{collection_id}","title":"Patch Collection","description":"Rename a collection and/or add, replace, or remove clauses by id.","href":"/api-reference/v1/update-collection"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Rename a collection and/or add, replace, or remove clauses by id.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"patch /v1/collections/{collection_id}","title":"Patch Collection","description":"Rename a collection and/or add, replace, or remove clauses by id.","href":"/api-reference/v1/update-collection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/channel3/adddcf3cd6dd6252/scripts/generate-categories-tree.js","/docs/_mintlify/custom/channel3/8c5186294b23fcfa/google-ads.js"],"openApiReferenceData":{"operation":{"tags":["collections"],"summary":"Patch Collection","description":"Rename a collection and/or add, replace, or remove clauses by id.","operationId":"patch_collection_v1_collections__collection_id__patch","security":["db55bfd7-c461-4059-9cdd-a1add3c7e859"],"parameters":["fcfc9526-d77f-44e1-ba68-21bfe58d0e53"],"requestBody":"cd3576ea-c515-4010-a638-15a8156a74a4","responses":{"200":"aedc8fde-df46-48bb-8ee8-14da8d909695","401":"35adab33-8717-40b7-bfe4-79693ed3a550","402":"c37bcbab-6f40-4d83-b098-f21ecdcac75a","404":"05da8956-bd41-45b8-987b-767ac47712bf","422":"7f14a980-bed6-4444-abcb-5f376115974e","500":"4ca34a27-45d4-4fba-9b42-7bac3974fe8f"},"x-codeSamples":[{"lang":"python","label":"Python","source":"from channel3_sdk import Channel3\nfrom channel3_sdk.environment import Channel3Environment\n\nclient = Channel3(\n api_key=\"\u003cvalue>\",\n environment=Channel3Environment.PRODUCTION,\n)\n\nclient.collections.update(\n collection_id=\"collection_id\",\n)\n"},{"lang":"typescript","label":"TypeScript","source":"import { Channel3 } from \"@channel3/sdk\";\n\nconst client = new Channel3({ apiKey: \"YOUR_API_KEY\" });\n\nawait client.collections.update({\n collection_id: \"collection_id\"\n});\n"}],"method":"patch","type":"path","servers":["8d3a489f-0ea4-4659-bfaa-b98ab9c45668"],"path":"/v1/collections/{collection_id}","baseUrlOptions":["https://api.trychannel3.com"],"title":"Patch Collection","codeSamples":[{"label":"Python","lang":"python","source":"from channel3_sdk import Channel3\nfrom channel3_sdk.environment import Channel3Environment\n\nclient = Channel3(\n api_key=\"\u003cvalue>\",\n environment=Channel3Environment.PRODUCTION,\n)\n\nclient.collections.update(\n collection_id=\"collection_id\",\n)\n"},{"label":"TypeScript","lang":"typescript","source":"import { Channel3 } from \"@channel3/sdk\";\n\nconst client = new Channel3({ apiKey: \"YOUR_API_KEY\" });\n\nawait client.collections.update({\n collection_id: \"collection_id\"\n});\n"}],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"fcfc9526-d77f-44e1-ba68-21bfe58d0e53":{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","title":"Collection Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","maxLength":1000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"add_clauses":{"oneOf":[{"type":"array","items":{"properties":{"brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].brand_ids","typeLabel":"string[] | null"},"website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].website_ids","typeLabel":"string[] | null"},"category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].category_ids","typeLabel":"string[] | null"},"product_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Product Ids","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Product Ids","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].product_ids","typeLabel":"string[] | null"},"exclude_brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_brand_ids","typeLabel":"string[] | null"},"exclude_website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_website_ids","typeLabel":"string[] | null"},"exclude_category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses.oneOf.0.items.[INDEX].exclude_category_ids","typeLabel":"string[] | null"}},"additionalProperties":false,"type":"object","title":"CollectionClauseInput","description":"Clause payload for create / add_clauses (server mints clause_id).","uniqueKey":"add_clauses.oneOf.0.items.[INDEX]","typeLabel":"CollectionClauseInput · object"},"title":"Add Clauses","uniqueKey":"add_clauses.oneOf.0","typeLabel":"CollectionClauseInput · object[]"},{"type":"null","title":"Add Clauses","uniqueKey":"add_clauses.oneOf.1","typeLabel":"null"}],"uniqueKey":"add_clauses","typeLabel":"CollectionClauseInput · object[] | null"},"replace_clauses":{"oneOf":[{"type":"array","items":{"properties":{"clause_id":{"type":"string","title":"Clause Id","isRequired":true,"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].clause_id","typeLabel":"string"},"brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].brand_ids","typeLabel":"string[] | null"},"website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].website_ids","typeLabel":"string[] | null"},"category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].category_ids","typeLabel":"string[] | null"},"product_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Product Ids","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Product Ids","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].product_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].product_ids","typeLabel":"string[] | null"},"exclude_brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_brand_ids","typeLabel":"string[] | null"},"exclude_website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_website_ids","typeLabel":"string[] | null"},"exclude_category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses.oneOf.0.items.[INDEX].exclude_category_ids","typeLabel":"string[] | null"}},"additionalProperties":false,"type":"object","required":["clause_id"],"title":"CollectionClause","description":"Persisted clause with a stable server-minted id.","uniqueKey":"replace_clauses.oneOf.0.items.[INDEX]","typeLabel":"CollectionClause · object"},"title":"Replace Clauses","description":"Replace existing clauses in place by clause_id. Position in the clauses list is unchanged.","uniqueKey":"replace_clauses.oneOf.0","typeLabel":"CollectionClause · object[]"},{"type":"null","title":"Replace Clauses","description":"Replace existing clauses in place by clause_id. Position in the clauses list is unchanged.","uniqueKey":"replace_clauses.oneOf.1","typeLabel":"null"}],"uniqueKey":"replace_clauses","typeLabel":"CollectionClause · object[] | null"},"remove_clause_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"remove_clause_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Remove Clause Ids","uniqueKey":"remove_clause_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Remove Clause Ids","uniqueKey":"remove_clause_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"remove_clause_ids","typeLabel":"string[] | null"}},"additionalProperties":false,"type":"object","title":"PatchCollectionRequest","uniqueKey":"","typeLabel":"PatchCollectionRequest · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","description":"\u003cstring>","add_clauses":[{"brand_ids":["\u003cstring>"],"website_ids":["\u003cstring>"],"category_ids":["\u003cstring>"],"product_ids":["\u003cstring>"],"exclude_brand_ids":["\u003cstring>"],"exclude_website_ids":["\u003cstring>"],"exclude_category_ids":["\u003cstring>"]}],"replace_clauses":[{"clause_id":"\u003cstring>","brand_ids":["\u003cstring>"],"website_ids":["\u003cstring>"],"category_ids":["\u003cstring>"],"product_ids":["\u003cstring>"],"exclude_brand_ids":["\u003cstring>"],"exclude_website_ids":["\u003cstring>"],"exclude_category_ids":["\u003cstring>"]}],"remove_clause_ids":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"aedc8fde-df46-48bb-8ee8-14da8d909695":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"collection_id":{"type":"string","title":"Collection Id","isRequired":true,"uniqueKey":"collection_id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"clauses":{"items":{"properties":{"clause_id":{"type":"string","title":"Clause Id","isRequired":true,"uniqueKey":"clauses.items.[INDEX].clause_id","typeLabel":"string"},"brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"clauses.items.[INDEX].brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Brand Ids","description":"OR within this list (any slot). AND with the clause's other lists. OR against other clauses.","uniqueKey":"clauses.items.[INDEX].brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].brand_ids","typeLabel":"string[] | null"},"website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"clauses.items.[INDEX].website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Website Ids","description":"Merchant ids; OR within this list (any matching offer). AND with the clause's other lists. Domains are accepted on write and stored as merchant ids. Also scopes displayed offers for products matched only by website-scoped clauses.","uniqueKey":"clauses.items.[INDEX].website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].website_ids","typeLabel":"string[] | null"},"category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"clauses.items.[INDEX].category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Category Ids","description":"OR within this list. AND with the clause's other lists.","uniqueKey":"clauses.items.[INDEX].category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].category_ids","typeLabel":"string[] | null"},"product_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].product_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Product Ids","uniqueKey":"clauses.items.[INDEX].product_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Product Ids","uniqueKey":"clauses.items.[INDEX].product_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].product_ids","typeLabel":"string[] | null"},"exclude_brand_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].exclude_brand_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"clauses.items.[INDEX].exclude_brand_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Brand Ids","description":"Clause-only; products missing a brand id still match.","uniqueKey":"clauses.items.[INDEX].exclude_brand_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].exclude_brand_ids","typeLabel":"string[] | null"},"exclude_website_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].exclude_website_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"clauses.items.[INDEX].exclude_website_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Website Ids","description":"Clause-only; domains become ids; another offer keeps the product.","uniqueKey":"clauses.items.[INDEX].exclude_website_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].exclude_website_ids","typeLabel":"string[] | null"},"exclude_category_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clauses.items.[INDEX].exclude_category_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"clauses.items.[INDEX].exclude_category_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Exclude Category Ids","description":"Clause-only; products missing category_ids still match.","uniqueKey":"clauses.items.[INDEX].exclude_category_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"clauses.items.[INDEX].exclude_category_ids","typeLabel":"string[] | null"}},"additionalProperties":false,"type":"object","required":["clause_id"],"title":"CollectionClause","description":"Persisted clause with a stable server-minted id.","uniqueKey":"clauses.items.[INDEX]","typeLabel":"CollectionClause · object"},"type":"array","title":"Clauses","isRequired":true,"uniqueKey":"clauses","typeLabel":"CollectionClause · object[]"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"user_id":{"oneOf":[{"type":"string","title":"User Id","uniqueKey":"user_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Id","uniqueKey":"user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_id","typeLabel":"string | null"}},"type":"object","required":["collection_id","name","clauses","created_at","updated_at"],"title":"CollectionResponse","uniqueKey":"","typeLabel":"CollectionResponse · object"},"examples":{"Example":{"title":"Example","value":{"collection_id":"\u003cstring>","name":"\u003cstring>","clauses":[{"clause_id":"\u003cstring>","brand_ids":["\u003cstring>"],"website_ids":["\u003cstring>"],"category_ids":["\u003cstring>"],"product_ids":["\u003cstring>"],"exclude_brand_ids":["\u003cstring>"],"exclude_website_ids":["\u003cstring>"],"exclude_category_ids":["\u003cstring>"]}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","user_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"35adab33-8717-40b7-bfe4-79693ed3a550":{"description":"Unauthorized - Invalid or missing authentication","content":{"application/json":{"examples":{"missing_key":{"title":"missing_key","summary":"Missing API Key","value":{"detail":"Unauthorized. Missing authentication key. Make sure to attach an x-api-key with your request. Need help? Reach out to support@channel3.ai."}},"invalid_key":{"title":"invalid_key","summary":"Invalid API Key","value":{"detail":"API key was provided but is invalid. Need help? Reach out to support@channel3.ai."}}},"schema":{"properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"Detail · object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | Detail · object[]"}},"type":"object","required":["detail"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"c37bcbab-6f40-4d83-b098-f21ecdcac75a":{"description":"Payment required","content":{"application/json":{"examples":{"credits_exhausted":{"title":"credits_exhausted","summary":"API key out of credits","value":{"detail":"You have used all of your free credits. Add a payment method to continue."}},"mpp_challenge":{"title":"mpp_challenge","summary":"MPP Tempo payment required","value":{"detail":"Payment required. Satisfy the MPP Tempo challenge in WWW-Authenticate."}}},"schema":{"properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"Detail · object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | Detail · object[]"}},"type":"object","required":["detail"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"05da8956-bd41-45b8-987b-767ac47712bf":{"description":"Not found","content":{"application/json":{"example":{"detail":"Collection not found"},"schema":{"properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"Detail · object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | Detail · object[]"}},"type":"object","required":["detail"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"Collection not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"7f14a980-bed6-4444-abcb-5f376115974e":{"description":"Validation error or invalid ids, including exclude lists","content":{"application/json":{"example":{"detail":"Collection was not created. Invalid brand_ids: 'brand_nike_abc123'"},"schema":{"properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"Detail · object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | Detail · object[]"}},"type":"object","required":["detail"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"Collection was not created. Invalid brand_ids: 'brand_nike_abc123'"}}},"exampleType":"examples"}},"exampleType":"examples"},"4ca34a27-45d4-4fba-9b42-7bac3974fe8f":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"detail.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Detail","isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"Detail · object[]"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | Detail · object[]"}},"type":"object","required":["detail"],"title":"ErrorResponse","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"detail":"Internal Server Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Internal Server Error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"db55bfd7-c461-4059-9cdd-a1add3c7e859":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"}}},"servers":{"8d3a489f-0ea4-4659-bfaa-b98ab9c45668":{"url":"https://api.trychannel3.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"x-api-key"}],"title":"APIKeyHeader"}]},"originalFileLocation":"openapi/openapi.json"},"subdomain":"channel3","siteName":"Channel3","title":"Patch Collection - Channel3","contextualStarterQuestions":[{"_id":"6ad68e41ca8229d73f433e21","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"Can I update by clause id?","status":"active","generatedBy":"contextual","path":"api-reference/v1/update-collection","createdAt":"2026-10-19T21:40:17.619Z","updatedAt":"2026-10-19T21:40:17.619Z","__v":0},{"_id":"6ad68e41ca8229d73f433e20","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"How do I add or remove clauses?","status":"active","generatedBy":"contextual","path":"api-reference/v1/update-collection","createdAt":"2026-10-19T21:40:17.619Z","updatedAt":"2026-10-19T21:40:17.619Z","__v":0},{"_id":"6ad68e41ca8229d73f433e1f","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"How do I rename a collection?","status":"active","generatedBy":"contextual","path":"api-reference/v1/update-collection","createdAt":"2026-10-19T21:40:17.619Z","updatedAt":"2026-10-19T21:40:17.619Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T21:39:51.473Z","originalFileLocation":"api-reference/v1/update-collection.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=\"Rename a collection and/or add, replace, or remove clauses by id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Channel3\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_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=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Patch Collection - Channel3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Rename a collection and/or add, replace, or remove clauses by id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Channel3\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://channel3.mintlify.site/docs/_mintlify/api/og/v2?division=Collections\u0026amp;title=Patch+Collection\u0026amp;description=Rename+a+collection+and%2For+add%2C+replace%2C+or+remove+clauses+by+id.\u0026amp;theme=3e46104af545c2aa15a9a043\u0026amp;signature=4635baf75336980d14e5e1275d9f30e6a725b569a5497ebdaf321ccea9d3cb7a\">\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=\"Patch Collection - Channel3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Rename a collection and/or add, replace, or remove clauses by id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://channel3.mintlify.site/docs/_mintlify/api/og/v2?division=Collections\u0026amp;title=Patch+Collection\u0026amp;description=Rename+a+collection+and%2For+add%2C+replace%2C+or+remove+clauses+by+id.\u0026amp;theme=3e46104af545c2aa15a9a043\u0026amp;signature=4635baf75336980d14e5e1275d9f30e6a725b569a5497ebdaf321ccea9d3cb7a\">\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=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Channel3\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6F96B5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v1/update-collection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://channel3.mintlify.dev/#organization\",\"name\":\"Channel3\",\"url\":\"https://channel3.mintlify.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-light.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=d23a7735ff07b0e7ad75f84ecffc413e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://channel3.mintlify.dev/docs#website\",\"name\":\"Channel3\",\"url\":\"https://channel3.mintlify.dev/docs\",\"publisher\":{\"@id\":\"https://channel3.mintlify.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection#webpage\",\"url\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection\",\"name\":\"Patch Collection\",\"description\":\"Rename a collection and/or add, replace, or remove clauses by id.\",\"dateModified\":\"2026-10-19T21:39:51.473Z\",\"isPartOf\":{\"@id\":\"https://channel3.mintlify.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Collections\",\"item\":\"https://channel3.mintlify.dev/docs/api-reference/v1/create-collection\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Patch Collection\",\"item\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection#apireference\",\"headline\":\"Patch Collection\",\"name\":\"Patch Collection\",\"description\":\"Rename a collection and/or add, replace, or remove clauses by id.\",\"url\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection\",\"mainEntityOfPage\":{\"@id\":\"https://channel3.mintlify.dev/docs/api-reference/v1/update-collection#webpage\"},\"dateModified\":\"2026-10-19T21:39:51.473Z\",\"publisher\":{\"@id\":\"https://channel3.mintlify.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://channel3.mintlify.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Channel3\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Channel3\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/v1/update-collection.md","siteName":"Channel3","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Products","pages":[{"openapi":"post /v1/search","title":"Search","href":"/api-reference/v1/search"},{"openapi":"post /v1/image-search","title":"Image Search","href":"/api-reference/v1/image-search"},{"openapi":"post /experimental/find-products-in-image","title":"Find products in an image","href":"/api-reference/v1/find-products-in-image"},{"openapi":"post /experimental/sticker","title":"Get a product sticker","href":"/api-reference/v1/sticker"},{"openapi":"post /v1/similar","title":"Similar Products","href":"/api-reference/v1/similar-products"},{"openapi":"get /v1/products/{product_id}","title":"Product Detail","href":"/api-reference/v1/product-detail"},{"openapi":"post /v1/lookup","title":"Lookup Product","href":"/api-reference/v1/lookup-product"},{"openapi":"post /v1/browse","title":"Browse","href":"/api-reference/v1/browse"}]},{"group":"Product Reviews","pages":[{"openapi":"post /v1/products/{product_id}/reviews","title":"Submit a product review","href":"/api-reference/v1/submit-product-review"},{"openapi":"get /v1/products/{product_id}/reviews","title":"List product reviews","href":"/api-reference/v1/list-product-reviews"}]},{"group":"Conversational Agent","pages":[{"title":"Create Turn","openapi":"post /v1/conversations","href":"/api-reference/v1/create-turn"},{"title":"Create Client Token","openapi":"post /v1/conversations/client_tokens","href":"/api-reference/v1/create-client-token"},{"title":"Revoke Client Token","openapi":"post /v1/conversations/client_tokens/revoke","href":"/api-reference/v1/revoke-client-token"},{"title":"Get Conversation","openapi":"get /v1/conversations/{conversation_id}","href":"/api-reference/v1/get-conversation"}]},{"group":"Collections","pages":[{"openapi":"post /v1/collections","title":"Create Collection","href":"/api-reference/v1/create-collection"},{"openapi":"get /v1/collections","title":"List Collections","href":"/api-reference/v1/list-collections"},{"openapi":"get /v1/collections/{collection_id}","title":"Get Collection","description":"Get a collection. Merged brand ids are rewritten to the surviving brand.","href":"/api-reference/v1/get-collection"},{"openapi":"patch /v1/collections/{collection_id}","title":"Patch Collection","href":"/api-reference/v1/update-collection"},{"openapi":"delete /v1/collections/{collection_id}","title":"Delete Collection","description":"Delete a collection.","href":"/api-reference/v1/delete-collection"}]},{"group":"Brands","pages":[{"openapi":"get /v1/brands/search","title":"Search Brands","href":"/api-reference/v1/search-brands"},{"openapi":"get /v1/brands","title":"List Brands","href":"/api-reference/v1/list-brands"},{"openapi":"get /v1/brands/{brand_id}","title":"Brand Detail","href":"/api-reference/v1/brand-detail"}]},{"group":"Categories","pages":[{"title":"Category Explorer","href":"/categories"},{"openapi":"get /v1/categories/search","title":"Search Categories","href":"/api-reference/v1/search-categories"},{"openapi":"get /v1/categories","title":"List Categories","href":"/api-reference/v1/list-categories"},{"openapi":"get /v1/categories/{slug}","title":"Category Detail","href":"/api-reference/v1/category-detail"}]},{"group":"Websites","pages":[{"openapi":"get /v1/websites/search","title":"Search Websites","href":"/api-reference/v1/search-websites"},{"openapi":"get /v1/websites","title":"List Websites","href":"/api-reference/v1/list-websites"},{"openapi":"get /v1/websites/{website_id}","title":"Website Detail","href":"/api-reference/v1/website-detail"},{"openapi":"get /v0/websites","title":"Websites","href":"/api-reference/channel3-api/websites"}]},{"group":"Reporting","pages":[{"openapi":"get /v1/reporting/clicks","title":"List Clicks","href":"/api-reference/v1/reporting-clicks"},{"openapi":"get /v1/reporting/transactions","title":"List Transactions","href":"/api-reference/v1/reporting-transactions"},{"openapi":"get /v1/reporting/usage","title":"Get API Usage","href":"/api-reference/v1/reporting-usage"},{"openapi":"post /v1/reporting/feedback","title":"Submit feedback","href":"/api-reference/v1/submit-feedback"}]},{"group":"Price \u0026 Availability","pages":[{"openapi":"post /v1/product-subscriptions","title":"Create Product Subscription","href":"/api-reference/product-subscriptions/create-subscription"},{"openapi":"get /v1/product-subscriptions","title":"List Product Subscriptions","href":"/api-reference/product-subscriptions/list-subscriptions"},{"openapi":"get /v1/product-subscriptions/{subscription_id}","title":"Get Product Subscription","href":"/api-reference/product-subscriptions/get-subscription"},{"openapi":"delete /v1/product-subscriptions/{subscription_id}","title":"Cancel Product Subscription","href":"/api-reference/product-subscriptions/cancel-subscription"},{"title":"Product Subscription Webhooks","icon":"webhook","href":"/product-subscription-webhooks"},{"openapi":"get /v0/price-tracking/history/{canonical_product_id}","title":"Get Price History","href":"/api-reference/price-tracking/get-price-history"},{"openapi":"post /v0/price-tracking/start","deprecated":true,"title":"Start Tracking","href":"/api-reference/price-tracking/start-tracking"},{"openapi":"post /v0/price-tracking/stop","deprecated":true,"title":"Stop Tracking","href":"/api-reference/price-tracking/stop-tracking"},{"openapi":"get /v0/price-tracking/subscriptions","deprecated":true,"title":"List Subscriptions","href":"/api-reference/price-tracking/list-subscriptions"},{"title":"Price Tracking Webhooks","icon":"webhook","href":"/price-tracking-webhooks"}]},{"group":"Webhooks","pages":[{"title":"offer.created","openapi":"webhook offer.created","href":"/api-reference/webhooks/offer-created"},{"title":"offer.price.changed","openapi":"webhook offer.price.changed","href":"/api-reference/webhooks/offer-price-changed"},{"title":"offer.availability.changed","openapi":"webhook offer.availability.changed","href":"/api-reference/webhooks/offer-availability-changed"},{"title":"offer.deleted","openapi":"webhook offer.deleted","href":"/api-reference/webhooks/offer-deleted"},{"title":"price.changed","openapi":"webhook price.changed","href":"/api-reference/webhooks/price-changed"}]},{"group":"Models","pages":[{"title":"Product","icon":"cube","href":"/product-model"},{"title":"Category","icon":"sitemap","href":"/api-reference/category-model"},{"title":"Brand","icon":"tag","href":"/api-reference/brand-model"},{"title":"Website","icon":"store","href":"/api-reference/website-model"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/announcements/update-7-component-library"}]}]},"basePath":"","title":"Patch Collection - Channel3","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}