Timestamp when broken links were last detected, if any.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cludo API Documentation","colors":{"primary":"#5B4EFF","light":"#8B7FFF","dark":"#3D2ECC"},"logo":{"light":"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f","dark":"https://mintcdn.com/cludo/QSqg9vB71E-uhtLM/images/Cludo_New_2021_White-01.png?fit=max\u0026auto=format\u0026n=QSqg9vB71E-uhtLM\u0026q=85\u0026s=96205b256cd0af679f7ed7cd6a7a9445"},"favicon":"https://mintcdn.com/cludo/PNai9WMfBGw4gQ9V/images/Cludo_Site_Icon.png?fit=max\u0026auto=format\u0026n=PNai9WMfBGw4gQ9V\u0026q=85\u0026s=2658cbf2e4ea92bc14f7210485c60b4c","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","python","javascript","typescript"],"prefill":true},"mdx":{"server":["https://api.cludo.com","https://api-us1.cludo.com"]}},"background":{"decoration":"gradient","color":{"light":"#f2f4f7"}},"navbar":{"links":[{"href":"https://cludo.com/resources/contact-support/","label":"Support"}],"primary":{"type":"button","label":"MyCludo","href":"https://my.cludo.com"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Support","href":"https://cludo.com/resources/contact-support"},{"label":"Status","href":"https://status.cludo.com"}]}]},"search":{},"fonts":{"family":"Poppins"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cludo","hasAudioNarration":false,"actualSubdomain":"cludo","customDomains":["docs.cludo.com"],"gitSource":{"type":"github","owner":"cludo","repo":"cludo-api-documentation-2026","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7582aee7653c65618e8c1","collectionId":"ee5697fb-ff48-4ada-9c32-bcbb28abed93","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7582aee7653c65618e8c1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad7582aee7653c65618e8c1","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Search Tools","count":22},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Quicklinks","count":7},{"language":"default","tag":"AI","count":6},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Content \u0026 Indexing","count":5},{"language":"default","tag":"Banners","count":5},{"language":"default","tag":"Page Rankings","count":5},{"language":"default","tag":"Get Started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@cludo.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles/custom.css","content":"body{color:#000000}"}],"page":{"pagePath":"api-reference/create-banner","slug":"/api-reference/create-banner","pageMetadata":{"title":"Create Banner","description":"Creates a banner. The server assigns `id`.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Creates a banner. The server assigns \", _jsx(_components.code, {\n children: \"id\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Banner","description":"Creates a banner. The server assigns `id`.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createBanner","summary":"Create Banner","description":"Creates a banner. The server assigns `id`.","security":["ff945f31-572c-4db8-ad1d-97d531b71ba8"],"requestBody":"8ae5bbbf-72e8-4228-9a02-87a8750a8f49","responses":{"201":"6da24c4c-e075-47de-a6d1-a9b45ed5f3d5","400":"905c0c59-7a4a-4835-8e90-1ea3cedd7e14","401":"b89c1aec-5ee8-4971-b9ef-bbfa22976631","500":"41b13b00-8f17-45ae-a439-6e355a53e5ce"},"method":"post","type":"path","servers":["36469293-ed74-4096-809f-c6babb9f39b2","a857e590-e1bd-4f3b-a35d-f4aa3f5dc51f"],"path":"/api/banners","baseUrlOptions":["https://api.cludo.com","https://api-us1.cludo.com"],"title":"Create Banner","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"\u003cstring>","body.htmlcode":"\u003cstring>","body.websiteid":123,"body.bannerterms.items.0.name":"\u003cstring>","body.isDisabled":true,"body.from.oneOf.0":"2023-11-07T05:31:56Z","body.to.oneOf.0":"2023-11-07T05:31:56Z","body.audiences.oneOf.0.items.0":"\u003cunknown>"}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Banner payload without `id` (server assigns `id`).","required":["name","htmlcode","websiteid"],"properties":{"name":{"type":"string","description":"Admin-facing name for the banner.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"htmlcode":{"type":"string","description":"Markup to render; validate in staging before production.","isRequired":true,"uniqueKey":"htmlcode","typeLabel":"string"},"websiteid":{"type":"integer","description":"Must match the engine you are configuring.","isRequired":true,"uniqueKey":"websiteid","typeLabel":"integer"},"bannerterms":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Search term or phrase that triggers this banner when the user’s query matches.","isRequired":true,"uniqueKey":"bannerterms.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"bannerterms.items.[INDEX]","typeLabel":"object"},"description":"Optional trigger list; omit for banners driven only by audience rules.","uniqueKey":"bannerterms","typeLabel":"object[]"},"isDisabled":{"type":"boolean","description":"Create in disabled state to review before go-live.","uniqueKey":"isDisabled","typeLabel":"boolean"},"from":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"from.oneOf.1","typeLabel":"null"}],"uniqueKey":"from","typeLabel":"string\u003cdate-time> | null"},"to":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"to.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"to.oneOf.1","typeLabel":"null"}],"uniqueKey":"to","typeLabel":"string\u003cdate-time> | null"},"audiences":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"audiences.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"audiences.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"audiences.oneOf.1","typeLabel":"null"}],"uniqueKey":"audiences","typeLabel":"any[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","htmlcode":"\u003cstring>","websiteid":123,"bannerterms":[{"name":"\u003cstring>"}],"isDisabled":true,"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z","audiences":["\u003cunknown>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6da24c4c-e075-47de-a6d1-a9b45ed5f3d5":{"description":"Banner created successfully.","content":{"application/json":{"schema":{"type":"object","required":["name","htmlcode","websiteid"],"properties":{"name":{"type":"string","description":"Internal label in MyCludo (not shown to end users).","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"htmlcode":{"type":"string","description":"HTML snippet injected on the SERP when terms match (keep accessible and scoped).","isRequired":true,"uniqueKey":"htmlcode","typeLabel":"string"},"websiteid":{"type":"integer","description":"Search engine ID.","isRequired":true,"uniqueKey":"websiteid","typeLabel":"integer"},"id":{"type":"integer","description":"Banner ID (assigned by server on create).","uniqueKey":"id","typeLabel":"integer"},"bannerterms":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Search term or phrase that triggers this banner when the user’s query matches.","isRequired":true,"uniqueKey":"bannerterms.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"bannerterms.items.[INDEX]","typeLabel":"object"},"description":"List of trigger phrases; any match can activate the banner depending on engine rules.","uniqueKey":"bannerterms","typeLabel":"object[]"},"isDisabled":{"type":"boolean","description":"When true, the banner is stored but never served.","uniqueKey":"isDisabled","typeLabel":"boolean"},"from":{"oneOf":[{"type":"string","format":"date-time","description":"Start of scheduled display window.","uniqueKey":"from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of scheduled display window.","uniqueKey":"from.oneOf.1","typeLabel":"null"}],"uniqueKey":"from","typeLabel":"string\u003cdate-time> | null"},"to":{"oneOf":[{"type":"string","format":"date-time","description":"End of scheduled display window.","uniqueKey":"to.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of scheduled display window.","uniqueKey":"to.oneOf.1","typeLabel":"null"}],"uniqueKey":"to","typeLabel":"string\u003cdate-time> | null"},"audiences":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"audiences.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"audiences.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"audiences.oneOf.1","typeLabel":"null"}],"uniqueKey":"audiences","typeLabel":"any[] | null"},"engineIds":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"engineIds.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Managed by the Cludo backend; informational only.","uniqueKey":"engineIds.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Managed by the Cludo backend; informational only.","uniqueKey":"engineIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"engineIds","typeLabel":"integer[] | null"},"frequency":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"frequency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency","typeLabel":"string | null"},"daysOfWeek":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"daysOfWeek.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"daysOfWeek.oneOf.1","typeLabel":"null"}],"uniqueKey":"daysOfWeek","typeLabel":"string | null"},"cssCode":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"cssCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"cssCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"cssCode","typeLabel":"string | null"},"jsonOption":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"jsonOption.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"jsonOption.oneOf.1","typeLabel":"null"}],"uniqueKey":"jsonOption","typeLabel":"string | null"},"editorType":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"editorType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"editorType.oneOf.1","typeLabel":"null"}],"uniqueKey":"editorType","typeLabel":"string | null"},"brokenLinksFoundAt":{"oneOf":[{"type":"string","description":"Timestamp when broken links were last detected, if any.","uniqueKey":"brokenLinksFoundAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when broken links were last detected, if any.","uniqueKey":"brokenLinksFoundAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"brokenLinksFoundAt","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","htmlcode":"\u003cstring>","websiteid":123,"id":123,"bannerterms":[{"name":"\u003cstring>"}],"isDisabled":true,"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z","audiences":["\u003cunknown>"],"engineIds":[123],"frequency":"\u003cstring>","daysOfWeek":"\u003cstring>","cssCode":"\u003cstring>","jsonOption":"\u003cstring>","editorType":"\u003cstring>","brokenLinksFoundAt":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"905c0c59-7a4a-4835-8e90-1ea3cedd7e14":{"description":"The request body failed validation. Each key in the response is the JSON path of the offending field.","content":{"application/json":{"schema":{"type":"object","description":"Per-field validation errors. Each key is the JSON path of the offending property (using the controller parameter name as the root) and the value is an array of error messages for that field. May also include a `general` key for non-field-specific messages.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"additionalProperties","typeLabel":"string[]"},"example":{"viewModel.pages[0]":["The Url field is required."]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"viewModel.pages[0]":["The Url field is required."]}}},"exampleType":"generated"}},"exampleType":"generated"},"b89c1aec-5ee8-4971-b9ef-bbfa22976631":{"description":"Authentication failed. The Authorization header is missing or contains invalid credentials.","content":{"application/json":{"schema":{"type":"object","description":"Returned when authentication fails.","properties":{"message":{"type":"string","description":"Authentication failure reason.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"message":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"41b13b00-8f17-45ae-a439-6e355a53e5ce":{"description":"An unexpected server error occurred. If this persists, contact support@cludo.com.","content":{"application/json":{"schema":{"type":"object","description":"Returned when an unexpected server error occurs.","properties":{"status":{"type":"string","description":"HTTP status name.","uniqueKey":"status","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code.","uniqueKey":"code","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX]","typeLabel":"string"},"description":"Error details, usually including a support reference id.","uniqueKey":"messages","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"examples":{"Example":{"title":"Example","value":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ff945f31-572c-4db8-ad1d-97d531b71ba8":{"BasicAuth":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]}}},"servers":{"36469293-ed74-4096-809f-c6babb9f39b2":{"url":"https://api.cludo.com","description":"EU region (Customer IDs below 10,000,000)"},"a857e590-e1bd-4f3b-a35d-f4aa3f5dc51f":{"url":"https://api-us1.cludo.com","description":"US region (Customer IDs 10,000,000 and above)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/search-tools.json"},"subdomain":"cludo","siteName":"Cludo API Documentation","title":"Create Banner - Cludo API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-13T15:05:13.858Z","originalFileLocation":"api-reference/create-banner.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a banner. The server assigns id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Banner - Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a banner. The server assigns id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cludo.com/api-reference/create-banner\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Banners\u0026amp;title=Create+Banner\u0026amp;description=Creates+a+banner.+The+server+assigns+%60id%60.\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=97705d6143d884f569fb0d04dd27b1702d4a5da38c47fa8bbd9d06d732584cf7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Banner - Cludo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a banner. The server assigns id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Banners\u0026amp;title=Create+Banner\u0026amp;description=Creates+a+banner.+The+server+assigns+%60id%60.\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=97705d6143d884f569fb0d04dd27b1702d4a5da38c47fa8bbd9d06d732584cf7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cludo.com/api-reference/create-banner\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-banner.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cludo.com/#organization\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cludo.com#website\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cludo.com/api-reference/create-banner#webpage\",\"url\":\"https://docs.cludo.com/api-reference/create-banner\",\"name\":\"Create Banner\",\"description\":\"Creates a banner. The server assigns id.\",\"dateModified\":\"2026-05-13T15:05:13.858Z\",\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cludo.com/api-reference/create-banner#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cludo.com/api-reference/create-banner#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search Tools\",\"item\":\"https://docs.cludo.com/api-reference/v4/search-tools/pre-search-suggestions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Banner\",\"item\":\"https://docs.cludo.com/api-reference/create-banner\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cludo.com/api-reference/create-banner#apireference\",\"headline\":\"Create Banner\",\"name\":\"Create Banner\",\"description\":\"Creates a banner. The server assigns id.\",\"url\":\"https://docs.cludo.com/api-reference/create-banner\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cludo.com/api-reference/create-banner#webpage\"},\"dateModified\":\"2026-05-13T15:05:13.858Z\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cludo API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cludo API Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/api-reference/overview"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /api/v4/{customerId}/{engineId}/search","href":"/api-reference/v4/search/search"},{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","href":"/api-reference/v4/search/autocomplete"}]},{"group":"AI","pages":[{"title":"AI Search Overview","href":"/api-reference/v4/ai/overview"},{"group":"AI Chat","pages":[{"title":"AI Chat","openapi":"POST /api/v4/{customerId}/{engineId}/search/answer","href":"/api-reference/v4/ai/chat"},{"title":"AI Chat Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/feedback","href":"/api-reference/ai-chat-feedback"},{"title":"AI Chat Click","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/click","href":"/api-reference/ai-chat-click"}]},{"group":"AI Summary","pages":[{"title":"AI Summary","openapi":"POST /api/v4/{customerId}/{engineId}/search/summarize","href":"/api-reference/v4/ai/summary"},{"title":"AI Summary Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/summarize/feedback","href":"/api-reference/ai-summary-feedback"}]}]},{"group":"Content \u0026 Indexing","pages":[{"group":"Documents","pages":[{"title":"Create or Replace","deprecated":null,"version":null,"openapi":"/openapi/index-management.json put /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/create-or-replace"},{"title":"Partial Update","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update"},{"title":"Single Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json delete /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/single-delete"},{"title":"Bulk Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete","href":"/api-reference/bulk-delete"}]},{"group":"Crawlers","pages":[{"title":"Queue URLs","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/crawler/{crawlerId}/paths","href":"/api-reference/queue-urls"}]}]},{"group":"Tracking","pages":[{"title":"Track Search Query","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/querylog","href":"/api-reference/track-search-query"},{"title":"Track Result Click","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/clicklog","href":"/api-reference/track-result-click"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","deprecated":null,"version":null,"openapi":"/openapi/feedback.json post /api/v4/{customerId}/{engineId}/feedback","href":"/api-reference/submit-feedback"}]},{"group":"Search Tools","pages":[{"title":"Pre-search Suggestions","description":"Fetch and render curated Pre-search Suggestions before a visitor starts typing in a custom search UI.","href":"/api-reference/v4/search-tools/pre-search-suggestions"},{"group":"Banners","pages":[{"title":"Create Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner"},{"title":"List Banners by Engine","description":"Returns all banners configured for the given search engine.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine"},{"title":"Get Single Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/{bannerId}","href":"/api-reference/get-single-banner"},{"title":"Update Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/banners/{bannerId}","href":"/api-reference/update-banner"},{"title":"Delete Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/banners/{bannerId}","href":"/api-reference/delete-banner"}]},{"group":"Page Rankings","pages":[{"title":"Create Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/rankings","href":"/api-reference/create-ranking"},{"title":"List Rankings by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/site/{engineId}","href":"/api-reference/list-rankings-by-engine"},{"title":"Get Single Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/{rankingId}","href":"/api-reference/get-single-ranking"},{"title":"Update Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/rankings/{rankingId}","href":"/api-reference/update-ranking"},{"title":"Delete Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/rankings/{rankingId}","href":"/api-reference/delete-ranking"}]},{"group":"Quicklinks","pages":[{"title":"Quicklinks","href":"/api-reference/v4/search-tools/quicklinks"},{"title":"Create Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/quicklinks","href":"/api-reference/create-quicklink"},{"title":"List Quicklinks","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinks","href":"/api-reference/list-quicklinks"},{"title":"Get Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/quicklinks/{quicklinkId}","href":"/api-reference/get-quicklink"},{"title":"Get Quicklinks by Terms","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinkterms","href":"/api-reference/get-quicklinks-by-terms"},{"title":"Update Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/quicklinks/{quicklinkId}","href":"/api-reference/update-quicklink"},{"title":"Delete Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/quicklinks/{quicklinkId}","href":"/api-reference/delete-quicklink"}]},{"group":"Synonyms","pages":[{"title":"Create Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/synonymsgroup","href":"/api-reference/create-synonym-group"},{"title":"Get Synonyms by Language or Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/synonymsgroup/{identifier}","href":"/api-reference/get-synonyms-by-language-or-synonym-group"},{"title":"Update Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/synonymsgroup","href":"/api-reference/update-synonym-group"},{"title":"Delete Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/synonymsgroup","href":"/api-reference/delete-synonym-group"}]}]}]}]},"basePath":"","title":"Create Banner - Cludo API Documentation","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"]}