{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Passport API Documentation","colors":{"primary":"#367CFF","light":"#367CFF","dark":"#367CFF"},"logo":{"light":"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/light.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=fc2bc30f86e845dd67e4eca1fec434c6","dark":"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/dark.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=f887f568cf687c7f9408bf840743c063"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:hi@mintlify.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"unblockedbrands","hasAudioNarration":false,"actualSubdomain":"unblockedbrands","customDomains":["docs.unblockedbrands.com"],"gitSource":{"type":"github","owner":"unblockedbrands","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e717044dd579e9b5887a","collectionId":"0b52f758-f035-4abd-b09e-b99526d85f78","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e717044dd579e9b5887a:success","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Passport - Push Notifications","count":6},{"language":"default","tag":"Passport - Locations","count":5},{"language":"default","tag":"Passport - Passes","count":5},{"language":"default","tag":"Pique","count":5},{"language":"default","tag":"Upload APIs","count":4},{"language":"default","tag":"Getting Started","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"per-site-search-delta","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":"editor-private-page-search","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/pique/create-pique-campaign","slug":"/api-reference/pique/create-pique-campaign","pageMetadata":{"title":"Create Pique Campaign","description":"Create a new Pique Campaign with the provided details.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /pique-campaign","href":"/api-reference/pique/create-pique-campaign","autogeneratedByOpenApi":true,"hidden":false},"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: \"Create a new Pique Campaign with the provided details.\"\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 Pique Campaign","description":"Create a new Pique Campaign with the provided details.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /pique-campaign","href":"/api-reference/pique/create-pique-campaign","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Pique"],"summary":"Create Pique Campaign","description":"Create a new Pique Campaign with the provided details.\n","operationId":"createPiqueCampaign","parameters":["8a781bc6-dea3-4152-bea3-2f57fba1d747"],"requestBody":"67ffbb95-ab67-4082-8cd1-dad5661d199e","responses":{"201":"0e697188-349d-41a6-99b6-0f2190713f93","400":"f1db5719-7757-468e-be67-18643f98c622","401":"507f98a8-561d-4678-925e-13a8a417d8d0"},"method":"post","type":"path","servers":["941c2dd2-5001-4bd3-a6cc-ef4009c675b7"],"security":["60d1a0e8-d1e9-4094-9d51-48bba759de68","407649c1-ed42-4564-8023-b8cd627cbd0c"],"path":"/pique-campaign","baseUrlOptions":["https://api.ubpass.co/v1"],"title":"Create Pique Campaign","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8a781bc6-dea3-4152-bea3-2f57fba1d747":{"name":"x-workspace-id","in":"header","description":"Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-_]+$","isRequired":false,"description":"Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user","uniqueKey":"","typeLabel":"string"},"example":"1f089d29-6f9c-66c2-af59-99631cec7ab5"}},"requestBody":{"description":"Request body for creating Pique Campaign","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"type":{"type":"string","enum":["BoostedPost","SyndicatedContent"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"targetViews":{"type":"integer","format":"int32","uniqueKey":"targetViews","typeLabel":"integer\u003cint32>"},"platforms":{"type":"array","items":{"type":"string","uniqueKey":"platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"platforms","typeLabel":"string[]"},"deliveredViews":{"type":"integer","format":"int32","uniqueKey":"deliveredViews","typeLabel":"integer\u003cint32>"},"contentLink":{"type":"string","uniqueKey":"contentLink","typeLabel":"string"},"submissionNotes":{"type":"string","uniqueKey":"submissionNotes","typeLabel":"string"},"endDate":{"type":"string","format":"date","uniqueKey":"endDate","typeLabel":"string\u003cdate>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","targetViews":123,"platforms":["\u003cstring>"],"deliveredViews":123,"contentLink":"\u003cstring>","submissionNotes":"\u003cstring>","endDate":"2023-12-25"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"0e697188-349d-41a6-99b6-0f2190713f93":{"description":"Campaign created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"workspaceId","typeLabel":"string"},"accountId":{"type":"string","uniqueKey":"accountId","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"type":{"type":"string","enum":["BoostedPost","SyndicatedContent"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["Prepping","InProgress","Completed","Paused","NotStarted","Canceled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"startDate":{"type":"string","format":"date","uniqueKey":"startDate","typeLabel":"string\u003cdate>"},"isPublished":{"type":"boolean","uniqueKey":"isPublished","typeLabel":"boolean"},"campaignData":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"campaignData.id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"campaignData.createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"campaignData.updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"campaignData.createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"campaignData.updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"campaignData.workspaceId","typeLabel":"string"},"campaignId":{"type":"string","uniqueKey":"campaignData.campaignId","typeLabel":"string"},"totalViews":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalViews","typeLabel":"integer\u003cint32>"},"totalClicks":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalClicks","typeLabel":"integer\u003cint32>"},"totalLikes":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalLikes","typeLabel":"integer\u003cint32>"},"totalCreators":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalCreators","typeLabel":"integer\u003cint32>"},"totalComments":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalComments","typeLabel":"integer\u003cint32>"},"totalShares":{"type":"integer","format":"int32","uniqueKey":"campaignData.totalShares","typeLabel":"integer\u003cint32>"},"totalVideos":{"type":"number","format":"double","uniqueKey":"campaignData.totalVideos","typeLabel":"number\u003cdouble>"},"instagramViews":{"type":"integer","format":"int32","uniqueKey":"campaignData.instagramViews","typeLabel":"integer\u003cint32>"},"instagramLikes":{"type":"integer","format":"int32","uniqueKey":"campaignData.instagramLikes","typeLabel":"integer\u003cint32>"},"instagramShares":{"type":"integer","format":"int32","uniqueKey":"campaignData.instagramShares","typeLabel":"integer\u003cint32>"},"instagramComments":{"type":"integer","format":"int32","uniqueKey":"campaignData.instagramComments","typeLabel":"integer\u003cint32>"},"tiktokViews":{"type":"integer","format":"int32","uniqueKey":"campaignData.tiktokViews","typeLabel":"integer\u003cint32>"},"tiktokLikes":{"type":"integer","format":"int32","uniqueKey":"campaignData.tiktokLikes","typeLabel":"integer\u003cint32>"},"tiktokShares":{"type":"integer","format":"int32","uniqueKey":"campaignData.tiktokShares","typeLabel":"integer\u003cint32>"},"tiktokComments":{"type":"integer","format":"int32","uniqueKey":"campaignData.tiktokComments","typeLabel":"integer\u003cint32>"},"assetFolderLink":{"type":"string","uniqueKey":"campaignData.assetFolderLink","typeLabel":"string"},"rec1":{"type":"string","uniqueKey":"campaignData.rec1","typeLabel":"string"},"rec2":{"type":"string","uniqueKey":"campaignData.rec2","typeLabel":"string"},"rec3":{"type":"string","uniqueKey":"campaignData.rec3","typeLabel":"string"},"rec4":{"type":"string","uniqueKey":"campaignData.rec4","typeLabel":"string"}},"uniqueKey":"campaignData","typeLabel":"object"},"campaignDataFileInfo":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"campaignDataFileInfo.fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"campaignDataFileInfo.fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"campaignDataFileInfo.url","typeLabel":"string"}},"uniqueKey":"campaignDataFileInfo","typeLabel":"object"},"videoPerformanceFileInfo":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"videoPerformanceFileInfo.fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"videoPerformanceFileInfo.fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"videoPerformanceFileInfo.url","typeLabel":"string"}},"uniqueKey":"videoPerformanceFileInfo","typeLabel":"object"},"platforms":{"type":"array","items":{"type":"string","uniqueKey":"platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"platforms","typeLabel":"string[]"},"targetViews":{"type":"integer","format":"int32","uniqueKey":"targetViews","typeLabel":"integer\u003cint32>"},"beforeViews":{"type":"integer","format":"int32","uniqueKey":"beforeViews","typeLabel":"integer\u003cint32>"},"afterViews":{"type":"integer","format":"int32","uniqueKey":"afterViews","typeLabel":"integer\u003cint32>"},"deliveredViews":{"type":"integer","format":"int32","uniqueKey":"deliveredViews","typeLabel":"integer\u003cint32>"},"contentLink":{"type":"string","uniqueKey":"contentLink","typeLabel":"string"},"submissionNotes":{"type":"string","uniqueKey":"submissionNotes","typeLabel":"string"},"endDate":{"type":"string","format":"date","uniqueKey":"endDate","typeLabel":"string\u003cdate>"},"beforeImage":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"beforeImage.fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"beforeImage.fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"beforeImage.url","typeLabel":"string"}},"uniqueKey":"beforeImage","typeLabel":"object"},"afterImage":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"afterImage.fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"afterImage.fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"afterImage.url","typeLabel":"string"}},"uniqueKey":"afterImage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","createdTime":"2025-05-13T15:07:15.036Z","updatedTime":"2025-05-13T15:07:15.036Z","createdBy":"\u003cstring>","updatedBy":"\u003cstring>","workspaceId":"\u003cstring>","accountId":"\u003cstring>","name":"\u003cstring>","type":"BoostedPost","status":"Prepping","startDate":"2023-12-25","isPublished":true,"campaignData":{"id":"\u003cstring>","createdTime":"2025-05-13T15:07:15.036Z","updatedTime":"2025-05-13T15:07:15.036Z","createdBy":"\u003cstring>","updatedBy":"\u003cstring>","workspaceId":"\u003cstring>","campaignId":"\u003cstring>","totalViews":123,"totalClicks":123,"totalLikes":123,"totalCreators":123,"totalComments":123,"totalShares":123,"totalVideos":123,"instagramViews":123,"instagramLikes":123,"instagramShares":123,"instagramComments":123,"tiktokViews":123,"tiktokLikes":123,"tiktokShares":123,"tiktokComments":123,"assetFolderLink":"\u003cstring>","rec1":"\u003cstring>","rec2":"\u003cstring>","rec3":"\u003cstring>","rec4":"\u003cstring>"},"campaignDataFileInfo":{"fileKey":"\u003cstring>","fileName":"\u003cstring>","url":"\u003cstring>"},"videoPerformanceFileInfo":{"fileKey":"\u003cstring>","fileName":"\u003cstring>","url":"\u003cstring>"},"platforms":["\u003cstring>"],"targetViews":123,"beforeViews":123,"afterViews":123,"deliveredViews":123,"contentLink":"\u003cstring>","submissionNotes":"\u003cstring>","endDate":"2023-12-25","beforeImage":{"fileKey":"\u003cstring>","fileName":"\u003cstring>","url":"\u003cstring>"},"afterImage":{"fileKey":"\u003cstring>","fileName":"\u003cstring>","url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f1db5719-7757-468e-be67-18643f98c622":{"description":"Bad Request - Invalid campaign data","content":{"application/json":{"schema":{"type":"object","properties":{"txId":{"type":"string","uniqueKey":"txId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMessage":{"type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"txId":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errorCode":"\u003cstring>","errorMessage":"\u003cstring>","context":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"507f98a8-561d-4678-925e-13a8a417d8d0":{"description":"Unauthorized - Invalid or missing authentication","content":{"application/json":{"schema":{"type":"object","properties":{"txId":{"type":"string","uniqueKey":"txId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMessage":{"type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"txId":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errorCode":"\u003cstring>","errorMessage":"\u003cstring>","context":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"60d1a0e8-d1e9-4094-9d51-48bba759de68":{"AccessToken":{"type":"http","description":"Bearer token authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]}},"407649c1-ed42-4564-8023-b8cd627cbd0c":{"APIKey":{"type":"apiKey","description":"API Key authentication","name":"api-key","in":"header","scopes":[]}}},"servers":{"941c2dd2-5001-4bd3-a6cc-ef4009c675b7":{"url":"https://api.ubpass.co/v1","description":"Generated server url"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Bearer token authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AccessToken","name":"Authorization"}],"title":"AccessToken"},{"schemes":[{"scheme":{"type":"apiKey","description":"API Key authentication","name":"api-key","in":"header","scopes":[]},"schema":{"title":"api-key","type":"string","description":"API Key authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKey","name":"api-key"}],"title":"APIKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"unblockedbrands","siteName":"Passport API Documentation","title":"Create Pique Campaign - Passport API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-17T07:56:08.287Z","originalFileLocation":"api-reference/pique/create-pique-campaign.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=\"Create a new Pique Campaign with the provided details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Passport 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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_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/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Pique Campaign - Passport API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new Pique Campaign with the provided details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Passport API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://unblockedbrands.mintlify.app/_mintlify/api/og/v2?division=Pique\u0026amp;title=Create+Pique+Campaign\u0026amp;description=Create+a+new+Pique+Campaign+with+the+provided+details.%0A\u0026amp;theme=dda4ad265c91f7b9b402560c\u0026amp;signature=6cbf3eff4e4c3b9b3eddf9299e127bbdf42548ac83fa4dfbc8683615bdd747ea\">\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 Pique Campaign - Passport API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new Pique Campaign with the provided details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://unblockedbrands.mintlify.app/_mintlify/api/og/v2?division=Pique\u0026amp;title=Create+Pique+Campaign\u0026amp;description=Create+a+new+Pique+Campaign+with+the+provided+details.%0A\u0026amp;theme=dda4ad265c91f7b9b402560c\u0026amp;signature=6cbf3eff4e4c3b9b3eddf9299e127bbdf42548ac83fa4dfbc8683615bdd747ea\">\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/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Passport API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#367CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pique/create-pique-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.unblockedbrands.com/#organization\",\"name\":\"Passport API Documentation\",\"url\":\"https://docs.unblockedbrands.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/light.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=fc2bc30f86e845dd67e4eca1fec434c6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.unblockedbrands.com#website\",\"name\":\"Passport API Documentation\",\"url\":\"https://docs.unblockedbrands.com\",\"publisher\":{\"@id\":\"https://docs.unblockedbrands.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign#webpage\",\"url\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign\",\"name\":\"Create Pique Campaign\",\"description\":\"Create a new Pique Campaign with the provided details.\",\"dateModified\":\"2025-11-17T07:56:08.287Z\",\"isPartOf\":{\"@id\":\"https://docs.unblockedbrands.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pique\",\"item\":\"https://docs.unblockedbrands.com/api-reference/pique/search-and-filter-pique-campaigns\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Pique Campaign\",\"item\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign#apireference\",\"headline\":\"Create Pique Campaign\",\"name\":\"Create Pique Campaign\",\"description\":\"Create a new Pique Campaign with the provided details.\",\"url\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.unblockedbrands.com/api-reference/pique/create-pique-campaign#webpage\"},\"dateModified\":\"2025-11-17T07:56:08.287Z\",\"publisher\":{\"@id\":\"https://docs.unblockedbrands.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.unblockedbrands.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Passport API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Passport API Documentation","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"},{"title":"API keys","icon":"key","href":"/api-reference/api-keys"}]},{"group":"Pique","pages":[{"title":"Search and filter Pique Campaigns","description":"Search and retrieve Pique Campaigns with optional filtering and pagination.\n\n**Features:**\n- Search campaigns by name using keyword query\n- Filter by campaign status (Prepping, InProgress, Completed, Paused, NotStarted, Cancelled)\n- Filter by campaign type (BoostedPost, SyndicatedContent)\n- Pagination support with cursor-based navigation\n- Returns only published campaigns for branded users\n\n**Pagination:**\n- Use `cursor` parameter for next page navigation\n- `limit` controls page size (default: 20)\n- Response includes `items` array, `cursor`, and `hasMore` fields\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign","href":"/api-reference/pique/search-and-filter-pique-campaigns"},{"title":"Create Pique Campaign","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /pique-campaign","href":"/api-reference/pique/create-pique-campaign"},{"title":"Get Pique Campaign by ID","description":"Retrieve a specific Pique Campaign by its unique identifier.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign/{id}","href":"/api-reference/pique/get-pique-campaign-by-id"},{"title":"Update Pique Campaign","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /pique-campaign/{id}","href":"/api-reference/pique/update-pique-campaign"},{"title":"Get Pique Campaign video performance data","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign/{id}/video-performance","href":"/api-reference/pique/get-pique-campaign-video-performance-data"}]},{"group":"Passport - Passes","pages":[{"title":"Search and filter Wallet Passes","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass","href":"/api-reference/passport--passes/search-and-filter-wallet-passes"},{"title":"Create a wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass","href":"/api-reference/passport--passes/create-a-wallet-pass"},{"title":"Create a wallet pass asynchronously","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass/async","href":"/api-reference/passport--passes/create-a-wallet-pass-asynchronously"},{"title":"Get wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/{id}","href":"/api-reference/passport--passes/get-wallet-pass"},{"title":"Update Wallet Pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /wallet-pass/{id}","href":"/api-reference/passport--passes/update-wallet-pass"}]},{"group":"Passport - Push Notifications","pages":[{"title":"Search and filter wallet pass notifications","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications","href":"/api-reference/passport--push-notifications/search-and-filter-wallet-pass-notifications"},{"title":"Create a notification for a wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass/notifications","href":"/api-reference/passport--push-notifications/create-a-notification-for-a-wallet-pass"},{"title":"Get wallet pass notification by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/get-wallet-pass-notification-by-id"},{"title":"Delete wallet pass notification","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/delete-wallet-pass-notification"},{"title":"Update wallet pass notification","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/update-wallet-pass-notification"},{"title":"Get notification statistics","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications/{id}/stats","href":"/api-reference/passport--push-notifications/get-notification-statistics"}]},{"group":"Passport - Locations","pages":[{"title":"Search and filter Wallet Pass Locations","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass-location","href":"/api-reference/passport--locations/search-and-filter-wallet-pass-locations"},{"title":"Create a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass-location","href":"/api-reference/passport--locations/create-a-wallet-pass-location"},{"title":"Get a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/get-a-wallet-pass-location"},{"title":"Update a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/update-a-wallet-pass-location"},{"title":"Delete a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/delete-a-wallet-pass-location"}]},{"group":"Upload APIs","pages":[{"title":"Upload a file to the server","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads","href":"/api-reference/upload-apis/upload-a-file-to-the-server"},{"title":"Upload a file to S3","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads/s3","href":"/api-reference/upload-apis/upload-a-file-to-s3"},{"title":"Finalize the S3 copy operation","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads/finalize/s3-copy","href":"/api-reference/upload-apis/finalize-the-s3-copy-operation"},{"title":"Get a pre-signed URL to upload a file to S3","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /uploads/s3-url","href":"/api-reference/upload-apis/get-a-pre-signed-url-to-upload-a-file-to-s3"}]}]}]},"title":"Create Pique Campaign - Passport API Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}