Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds.
Required permissions:manage-workspace-branding · API keys: allowed
Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AllRide Vouchers — Consumer API","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/light.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=92f0ea94edcefc1febba871b5ead8cdd","dark":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/dark.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=c5e31c42ccee8249e8a321e4a1064b5d","href":"https://docs-consumer.voucher.allride.io"},"favicon":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/favicon.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=7a8b0fcba322123aacae3e4c870276d3","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","javascript","python","java","go","php"]}},"navbar":{"links":[{"href":"https://consumer-developers.voucher-staging.allride.io/go/overview","label":"Sandbox dashboard"},{"href":"https://allride.io","label":"Support"}],"primary":{"type":"button","label":"Developer dashboard","href":"https://consumer-developers.voucher.allride.io/go/api-keys"}},"footer":{"links":[{"header":"AllRide","items":[{"label":"Imprint","href":"https://www.allride.io/impressum"},{"label":"Privacy","href":"https://www.allride.io/datenschutz"}]}]},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"allride-voucher-consumer","hasAudioNarration":false,"actualSubdomain":"allride-voucher-consumer","customDomains":[],"gitSource":{"type":"github","owner":"allride-mobility","repo":"allridevoucherpartnerconsumerapidocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6adf634194b1979157fe3cae"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae9bdb007405bf5d5959ed9","collectionId":"b9f9a568-3bc7-4868-ba2c-e500f0d532c1","liveDeploymentHistoryId":"6ae9bdb007405bf5d5959ed9","schemaVersion":"v3"},"entitlements":{},"buildId":"6ae9c317bf4ef845262b05b7","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":141},{"language":"default","tag":"Consumer API","count":72},{"language":"default","tag":"Workspace API","count":69},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Webhook events","count":24},{"language":"default","tag":"Billing","count":20},{"language":"default","tag":"Catalog","count":15},{"language":"default","tag":"Email (SMTP and templates)","count":15},{"language":"default","tag":"Webhook endpoints","count":12},{"language":"default","tag":"Consumer guides","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:not(.dark) .method-nav-pill .text-green-700{color:#14532d}html:not(.dark) .method-nav-pill .text-blue-700{color:#1e3a8a}html:not(.dark) .method-nav-pill .text-red-700{color:#7f1d1d}html:not(.dark) .method-nav-pill .text-orange-700{color:#7c2d12}html:not(.dark) .method-nav-pill .text-yellow-700{color:#713f12}html:not(.dark) .method-nav-pill .text-purple-700{color:#581c87}html:not(.dark) [data-component-part=field-required-pill]{color:#991b1b}"}],"page":{"pagePath":"api-reference/partner-workspace-branding-replace","slug":"/api-reference/partner-workspace-branding-replace","pageMetadata":{"title":"Replace workspace branding","description":"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 `content-blocked`). Clearing `landing.privacyUrl` or `landing.imprintUrl` is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds.\n\n**Required permissions:** `manage-workspace-branding` · **API keys:** allowed","deprecated":null,"version":null,"sidebarTitle":"Partner workspace branding replace","openapi":"/openapi/consumer.v1.json put /partner/v1/branding/workspace","href":"/api-reference/partner-workspace-branding-replace","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 \", _jsx(_components.code, {\n children: \"content-blocked\"\n }), \"). Clearing \", _jsx(_components.code, {\n children: \"landing.privacyUrl\"\n }), \" or \", _jsx(_components.code, {\n children: \"landing.imprintUrl\"\n }), \" is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required permissions:\"\n }), \" \", _jsx(_components.code, {\n children: \"manage-workspace-branding\"\n }), \" · \", _jsx(_components.strong, {\n children: \"API keys:\"\n }), \" allowed\"]\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":"Replace workspace branding","description":"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 `content-blocked`). Clearing `landing.privacyUrl` or `landing.imprintUrl` is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds.\n\n**Required permissions:** `manage-workspace-branding` · **API keys:** allowed","deprecated":null,"version":null,"sidebarTitle":"Partner workspace branding replace","openapi":"/openapi/consumer.v1.json put /partner/v1/branding/workspace","href":"/api-reference/partner-workspace-branding-replace","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"partner.workspace-branding.replace","summary":"Replace workspace branding","description":"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 `content-blocked`). Clearing `landing.privacyUrl` or `landing.imprintUrl` is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds.\n\n**Required permissions:** `manage-workspace-branding` · **API keys:** allowed","tags":["Workspace branding"],"requestBody":"40075fbd-515b-4e57-a941-e9ccdf22ea16","responses":{"200":"b74d80d4-34bd-4cdd-89e7-e46536e4547d","201":"9150471b-e1e3-4283-b756-0f647396b2b3","400":"0859be62-3519-4420-895e-ef9cbd63499f","401":"f561d3ac-76e1-467a-8b4e-1adb0a363c65","403":"ecf84643-6f97-43ef-969e-be0655b528f6","404":"220428bc-205c-4802-96c9-83cd87bef36d","409":"6f21fd7a-6dec-4008-8bca-ec7423a17460","422":"c22df60e-72c9-46e7-9832-a79e0375e07b","500":"0249322b-5f54-40be-92c8-4a49e133fbdd","503":"555a7d94-3a25-42e8-bb3c-ca598c3bf500"},"x-permissions":["manage-workspace-branding"],"x-audience":"partner","x-api-key-callable":true,"x-mint":{"href":"/api-reference/partner-workspace-branding-replace"},"method":"put","type":"path","servers":["194c8b4a-ee81-4799-8d91-168cc798538c"],"security":["e665e8eb-c733-4f11-acb6-1852122ca357"],"path":"/partner/v1/branding/workspace","baseUrlOptions":["https://api.voucher-staging.allride.io"],"title":"Replace workspace branding","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","java","go","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"primaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"primaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"primaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"primaryColor","typeLabel":"string | null"},"secondaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"secondaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"secondaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"secondaryColor","typeLabel":"string | null"},"backgroundColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"backgroundColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"backgroundColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"backgroundColor","typeLabel":"string | null"},"surfaceColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"surfaceColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"surfaceColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"surfaceColor","typeLabel":"string | null"},"textColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"textColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"textColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"textColor","typeLabel":"string | null"},"accentColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"accentColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"accentColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accentColor","typeLabel":"string | null"},"buttonColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"buttonColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"buttonColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buttonColor","typeLabel":"string | null"},"buttonTextColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"buttonTextColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"buttonTextColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buttonTextColor","typeLabel":"string | null"},"buttonBorderColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"buttonBorderColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"buttonBorderColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"buttonBorderColor","typeLabel":"string | null"},"logoAssetId":{"oneOf":[{"type":"integer","description":"Logo asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"logoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo asset.","isRequired":true,"uniqueKey":"logoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"logoAssetId","typeLabel":"integer\u003cuint64> | null"},"logoDarkAssetId":{"oneOf":[{"type":"integer","description":"Logo for dark backgrounds.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"logoDarkAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo for dark backgrounds.","isRequired":true,"uniqueKey":"logoDarkAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"logoDarkAssetId","typeLabel":"integer\u003cuint64> | null"},"iconAssetId":{"oneOf":[{"type":"integer","description":"Icon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"iconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Icon asset.","isRequired":true,"uniqueKey":"iconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"iconAssetId","typeLabel":"integer\u003cuint64> | null"},"heroImageAssetId":{"oneOf":[{"type":"integer","description":"Hero image asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"heroImageAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Hero image asset.","isRequired":true,"uniqueKey":"heroImageAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"heroImageAssetId","typeLabel":"integer\u003cuint64> | null"},"faviconAssetId":{"oneOf":[{"type":"integer","description":"Favicon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"faviconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Favicon asset.","isRequired":true,"uniqueKey":"faviconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"faviconAssetId","typeLabel":"integer\u003cuint64> | null"},"emailLogoAssetId":{"oneOf":[{"type":"integer","description":"Logo used in emails.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"emailLogoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo used in emails.","isRequired":true,"uniqueKey":"emailLogoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailLogoAssetId","typeLabel":"integer\u003cuint64> | null"},"fontFamily":{"oneOf":[{"type":"string","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"fontFamily.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"fontFamily.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fontFamily","typeLabel":"enum\u003cstring> | null"},"cornerRadius":{"oneOf":[{"type":"string","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"cornerRadius.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"cornerRadius.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cornerRadius","typeLabel":"enum\u003cstring> | null"},"extensions":{"oneOf":[{"type":"object","description":"Free-form extension values (keys `x-*`); scanned like every text.","example":{"orderId":"8812","channel":"app"},"additionalProperties":true,"isRequired":true,"uniqueKey":"extensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Free-form extension values (keys `x-*`); scanned like every text.","isRequired":true,"uniqueKey":"extensions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"extensions","typeLabel":"object | null"},"landing":{"oneOf":[{"type":"object","description":"Consumer landing block; `null` until set.","required":["title","intro","termsUrl","privacyUrl","imprintUrl","supportEmail","supportUrl","footerText","showProviderSearch","look","botProtection"],"properties":{"title":{"oneOf":[{"type":"object","description":"Landing page title (at most 80 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"landing.oneOf.0.title.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"landing.oneOf.0.title.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"landing.oneOf.0.title.oneOf.0","typeLabel":"object"},{"type":"null","description":"Landing page title (at most 80 characters per locale).","isRequired":true,"uniqueKey":"landing.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.title","typeLabel":"object | null"},"intro":{"oneOf":[{"type":"object","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","example":{"de":"Gültig für **alle** E-Scooter.","en":"Valid for **all** e-scooters."},"properties":{"de":{"type":"string","description":"German Markdown.","uniqueKey":"landing.oneOf.0.intro.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English Markdown.","uniqueKey":"landing.oneOf.0.intro.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"landing.oneOf.0.intro.oneOf.0","typeLabel":"object"},{"type":"null","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","isRequired":true,"uniqueKey":"landing.oneOf.0.intro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.intro","typeLabel":"object | null"},"termsUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"landing.oneOf.0.termsUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"landing.oneOf.0.termsUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.termsUrl","typeLabel":"string\u003curi> | null"},"privacyUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"landing.oneOf.0.privacyUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"landing.oneOf.0.privacyUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.privacyUrl","typeLabel":"string\u003curi> | null"},"imprintUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"landing.oneOf.0.imprintUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"landing.oneOf.0.imprintUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.imprintUrl","typeLabel":"string\u003curi> | null"},"supportEmail":{"oneOf":[{"type":"string","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"landing.oneOf.0.supportEmail.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"landing.oneOf.0.supportEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.supportEmail","typeLabel":"string\u003cemail> | null"},"supportUrl":{"oneOf":[{"type":"string","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"landing.oneOf.0.supportUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"landing.oneOf.0.supportUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.supportUrl","typeLabel":"string\u003curi> | null"},"footerText":{"oneOf":[{"type":"object","description":"Footer text (at most 300 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"landing.oneOf.0.footerText.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"landing.oneOf.0.footerText.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"landing.oneOf.0.footerText.oneOf.0","typeLabel":"object"},{"type":"null","description":"Footer text (at most 300 characters per locale).","isRequired":true,"uniqueKey":"landing.oneOf.0.footerText.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing.oneOf.0.footerText","typeLabel":"object | null"},"showProviderSearch":{"type":"boolean","description":"Show the provider search on the landing page.","isRequired":true,"uniqueKey":"landing.oneOf.0.showProviderSearch","typeLabel":"boolean"},"look":{"type":"string","enum":["vibrant","soft","bold","clean"],"description":"Landing Look: how colourful the landing pages are. Optional on write (default `vibrant`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"landing.oneOf.0.look","typeLabel":"enum\u003cstring>"},"botProtection":{"type":"string","enum":["off","turnstile"],"description":"Bot protection of your Redemption Link landing pages. `turnstile` shows the Cloudflare Turnstile widget and requires its token on the OTP request and the redeem. Optional on write (default `off`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"landing.oneOf.0.botProtection","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"landing.oneOf.0","typeLabel":"object"},{"type":"null","description":"Consumer landing block; `null` until set.","isRequired":true,"uniqueKey":"landing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"landing","typeLabel":"object | null"}},"required":["primaryColor","secondaryColor","backgroundColor","surfaceColor","textColor","accentColor","buttonColor","buttonTextColor","buttonBorderColor","logoAssetId","logoDarkAssetId","iconAssetId","heroImageAssetId","faviconAssetId","emailLogoAssetId","fontFamily","cornerRadius","extensions","landing"],"additionalProperties":false,"description":"Workspace Branding content.","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"primaryColor":"#c8102e","secondaryColor":null,"backgroundColor":"#ffffff","surfaceColor":"#f5f5f5","textColor":"#1a1a1a","accentColor":null,"buttonColor":"#c8102e","buttonTextColor":"#ffffff","buttonBorderColor":null,"logoAssetId":3095,"logoDarkAssetId":null,"iconAssetId":null,"heroImageAssetId":null,"faviconAssetId":null,"emailLogoAssetId":null,"fontFamily":"source-sans-3","cornerRadius":"md","extensions":null,"landing":{"title":{"de":"Ihre Mobilitätsgutscheine","en":"Your mobility vouchers"},"intro":{"de":"Wählen Sie einen Anbieter.","en":"Choose a provider."},"termsUrl":"https://www.example-transit.example.com/vouchers/terms","privacyUrl":"https://www.example-transit.example.com/privacy","imprintUrl":"https://www.example-transit.example.com/imprint","supportEmail":"[email protected]","supportUrl":null,"footerText":null,"showProviderSearch":true,"look":"vibrant","botProtection":"turnstile"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b74d80d4-34bd-4cdd-89e7-e46536e4547d":{"description":"Saved: every later save.","headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}},"Idempotency-Key-Ignored":{"description":"`true` when you sent `Idempotency-Key` on a method that ignores it.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"type":"object","description":"Single-object envelope around a `WorkspaceBranding`.","properties":{"data":{"type":"object","description":"Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails.","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Numeric id of the resource, unique per resource type.","isRequired":true,"uniqueKey":"data.id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["branding"],"description":"Always `branding`.","isRequired":true,"uniqueKey":"data.resource","typeLabel":"enum\u003cstring>"},"partnerId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Your partner id.","isRequired":true,"uniqueKey":"data.partnerId","typeLabel":"integer\u003cuint64>"},"scope":{"type":"string","enum":["workspace"],"description":"Always `workspace` here. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.scope","typeLabel":"enum\u003cstring>"},"live":{"oneOf":[{"type":"object","description":"Current branding; `null` until the first save.","required":["primaryColor","secondaryColor","backgroundColor","surfaceColor","textColor","accentColor","buttonColor","buttonTextColor","buttonBorderColor","logoAssetId","logoDarkAssetId","iconAssetId","heroImageAssetId","faviconAssetId","emailLogoAssetId","fontFamily","cornerRadius","extensions","landing"],"properties":{"primaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor","typeLabel":"string | null"},"secondaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor","typeLabel":"string | null"},"backgroundColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor","typeLabel":"string | null"},"surfaceColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor","typeLabel":"string | null"},"textColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor","typeLabel":"string | null"},"accentColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor","typeLabel":"string | null"},"buttonColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor","typeLabel":"string | null"},"buttonTextColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor","typeLabel":"string | null"},"buttonBorderColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor","typeLabel":"string | null"},"logoAssetId":{"oneOf":[{"type":"integer","description":"Logo asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId","typeLabel":"integer\u003cuint64> | null"},"logoDarkAssetId":{"oneOf":[{"type":"integer","description":"Logo for dark backgrounds.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo for dark backgrounds.","isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId","typeLabel":"integer\u003cuint64> | null"},"iconAssetId":{"oneOf":[{"type":"integer","description":"Icon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Icon asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId","typeLabel":"integer\u003cuint64> | null"},"heroImageAssetId":{"oneOf":[{"type":"integer","description":"Hero image asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Hero image asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId","typeLabel":"integer\u003cuint64> | null"},"faviconAssetId":{"oneOf":[{"type":"integer","description":"Favicon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Favicon asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId","typeLabel":"integer\u003cuint64> | null"},"emailLogoAssetId":{"oneOf":[{"type":"integer","description":"Logo used in emails.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo used in emails.","isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId","typeLabel":"integer\u003cuint64> | null"},"fontFamily":{"oneOf":[{"type":"string","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily","typeLabel":"enum\u003cstring> | null"},"cornerRadius":{"oneOf":[{"type":"string","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius","typeLabel":"enum\u003cstring> | null"},"extensions":{"oneOf":[{"type":"object","description":"Free-form extension values (keys `x-*`); scanned like every text.","example":{"orderId":"8812","channel":"app"},"additionalProperties":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Free-form extension values (keys `x-*`); scanned like every text.","isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions","typeLabel":"object | null"},"landing":{"oneOf":[{"type":"object","description":"Consumer landing block; `null` until set.","required":["title","intro","termsUrl","privacyUrl","imprintUrl","supportEmail","supportUrl","footerText","showProviderSearch","look","botProtection"],"properties":{"title":{"oneOf":[{"type":"object","description":"Landing page title (at most 80 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0","typeLabel":"object"},{"type":"null","description":"Landing page title (at most 80 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title","typeLabel":"object | null"},"intro":{"oneOf":[{"type":"object","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","example":{"de":"Gültig für **alle** E-Scooter.","en":"Valid for **all** e-scooters."},"properties":{"de":{"type":"string","description":"German Markdown.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English Markdown.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0","typeLabel":"object"},{"type":"null","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro","typeLabel":"object | null"},"termsUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl","typeLabel":"string\u003curi> | null"},"privacyUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl","typeLabel":"string\u003curi> | null"},"imprintUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl","typeLabel":"string\u003curi> | null"},"supportEmail":{"oneOf":[{"type":"string","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail","typeLabel":"string\u003cemail> | null"},"supportUrl":{"oneOf":[{"type":"string","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl","typeLabel":"string\u003curi> | null"},"footerText":{"oneOf":[{"type":"object","description":"Footer text (at most 300 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0","typeLabel":"object"},{"type":"null","description":"Footer text (at most 300 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText","typeLabel":"object | null"},"showProviderSearch":{"type":"boolean","description":"Show the provider search on the landing page.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.showProviderSearch","typeLabel":"boolean"},"look":{"type":"string","enum":["vibrant","soft","bold","clean"],"description":"Landing Look: how colourful the landing pages are. Optional on write (default `vibrant`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.look","typeLabel":"enum\u003cstring>"},"botProtection":{"type":"string","enum":["off","turnstile"],"description":"Bot protection of your Redemption Link landing pages. `turnstile` shows the Cloudflare Turnstile widget and requires its token on the OTP request and the redeem. Optional on write (default `off`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.botProtection","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0","typeLabel":"object"},{"type":"null","description":"Consumer landing block; `null` until set.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0","typeLabel":"object"},{"type":"null","description":"Current branding; `null` until the first save.","isRequired":true,"uniqueKey":"data.live.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live","typeLabel":"object | null"},"liveRevisionNo":{"type":"integer","description":"Number of saves.","isRequired":true,"uniqueKey":"data.liveRevisionNo","typeLabel":"integer"},"pendingChangeRequestId":{"type":"null","description":"Always `null` for Workspace Branding (no approval needed).","isRequired":true,"uniqueKey":"data.pendingChangeRequestId","typeLabel":"null"},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Asset id.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["brand-asset"],"description":"Always `brand-asset`.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].resource","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["logo","logo-dark","icon","hero","favicon","email-logo"],"description":"Asset kind. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"publicUrl":{"type":"string","format":"uri","description":"Public URL.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].publicUrl","typeLabel":"string\u003curi>"},"width":{"oneOf":[{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height","typeLabel":"integer | null"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants","typeLabel":"object | null"},"_links":{"type":"object","properties":{"self":{"type":"object","description":"The asset.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"description":"Links.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links","typeLabel":"object"}},"required":["id","resource","kind","publicUrl","width","height","variants","_links"],"additionalProperties":false,"description":"A referenced brand asset.","uniqueKey":"data.assets.items.[INDEX]","typeLabel":"object"},"description":"Every asset referenced by `live`.","isRequired":true,"uniqueKey":"data.assets","typeLabel":"object[]"},"assetUrls":{"type":"object","properties":{"logo":{"oneOf":[{"type":"object","description":"logo image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0","typeLabel":"object"},{"type":"null","description":"logo image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logo","typeLabel":"object | null"},"logoDark":{"oneOf":[{"type":"object","description":"logoDark image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0","typeLabel":"object"},{"type":"null","description":"logoDark image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logoDark","typeLabel":"object | null"},"icon":{"oneOf":[{"type":"object","description":"icon image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0","typeLabel":"object"},{"type":"null","description":"icon image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.icon","typeLabel":"object | null"},"hero":{"oneOf":[{"type":"object","description":"hero image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0","typeLabel":"object"},{"type":"null","description":"hero image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.hero","typeLabel":"object | null"},"favicon":{"oneOf":[{"type":"object","description":"favicon image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0","typeLabel":"object"},{"type":"null","description":"favicon image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.favicon","typeLabel":"object | null"},"emailLogo":{"oneOf":[{"type":"object","description":"emailLogo image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0","typeLabel":"object"},{"type":"null","description":"emailLogo image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo","typeLabel":"object | null"}},"required":["logo","logoDark","icon","hero","favicon","emailLogo"],"additionalProperties":false,"description":"Render map of the referenced images.","isRequired":true,"uniqueKey":"data.assetUrls","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the resource was created.","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the resource was last changed.","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"_links":{"type":"object","description":"Related resources you may follow (HAL style). A link is present only when you hold the target's permissions.","properties":{"self":{"type":"object","description":"This resource.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"data._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"data._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data._links.self","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data._links","typeLabel":"object"}},"required":["id","resource","partnerId","scope","live","liveRevisionNo","pendingChangeRequestId","assets","assetUrls","createdAt","updatedAt","_links"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"data":{"id":37069,"resource":"branding","partnerId":1069,"scope":"workspace","live":{"primaryColor":"#c8102e","secondaryColor":null,"backgroundColor":"#ffffff","surfaceColor":"#f5f5f5","textColor":"#1a1a1a","accentColor":null,"buttonColor":"#c8102e","buttonTextColor":"#ffffff","buttonBorderColor":null,"logoAssetId":3095,"logoDarkAssetId":null,"iconAssetId":null,"heroImageAssetId":null,"faviconAssetId":null,"emailLogoAssetId":null,"fontFamily":"source-sans-3","cornerRadius":"md","extensions":null,"landing":{"title":{"de":"Ihre Mobilitätsgutscheine","en":"Your mobility vouchers"},"intro":{"de":"Wählen Sie einen Anbieter.","en":"Choose a provider."},"termsUrl":"https://www.example-transit.example.com/vouchers/terms","privacyUrl":"https://www.example-transit.example.com/privacy","imprintUrl":"https://www.example-transit.example.com/imprint","supportEmail":"[email protected]","supportUrl":null,"footerText":null,"showProviderSearch":true,"look":"vibrant","botProtection":"turnstile"}},"liveRevisionNo":3,"pendingChangeRequestId":null,"assets":[{"id":3095,"resource":"brand-asset","kind":"logo","publicUrl":"https://assets.voucher.allride.io/example-transit/3095.png","width":512,"height":128,"variants":null,"_links":{"self":{"href":"https://api.voucher.allride.io/partner/v1/brand-assets/3095","type":"application/json"}}}],"assetUrls":{"logo":{"assetId":3095,"url":"https://assets.voucher.allride.io/example-transit/3095.png","width":512,"height":128,"variants":null},"logoDark":null,"icon":null,"hero":null,"favicon":null,"emailLogo":null},"createdAt":"2026-10-19T14:02:11.418Z","updatedAt":"2026-10-22T08:00:00Z","_links":{"self":{"href":"https://api.voucher.allride.io/partner/v1/branding/workspace","type":"application/json"}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"9150471b-e1e3-4283-b756-0f647396b2b3":{"description":"Created: the first save (`liveRevisionNo` 0 to 1), with `Location`.","headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}},"Idempotency-Key-Ignored":{"description":"`true` when you sent `Idempotency-Key` on a method that ignores it.","schema":{"type":"string","enum":["true"]}},"Location":{"description":"Absolute URL of the created resource or the job to poll.","schema":{"type":"string","format":"uri"}}},"content":{"application/json":{"schema":{"type":"object","description":"Single-object envelope around a `WorkspaceBranding`.","properties":{"data":{"type":"object","description":"Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails.","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Numeric id of the resource, unique per resource type.","isRequired":true,"uniqueKey":"data.id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["branding"],"description":"Always `branding`.","isRequired":true,"uniqueKey":"data.resource","typeLabel":"enum\u003cstring>"},"partnerId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Your partner id.","isRequired":true,"uniqueKey":"data.partnerId","typeLabel":"integer\u003cuint64>"},"scope":{"type":"string","enum":["workspace"],"description":"Always `workspace` here. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.scope","typeLabel":"enum\u003cstring>"},"live":{"oneOf":[{"type":"object","description":"Current branding; `null` until the first save.","required":["primaryColor","secondaryColor","backgroundColor","surfaceColor","textColor","accentColor","buttonColor","buttonTextColor","buttonBorderColor","logoAssetId","logoDarkAssetId","iconAssetId","heroImageAssetId","faviconAssetId","emailLogoAssetId","fontFamily","cornerRadius","extensions","landing"],"properties":{"primaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Primary colour `#rrggbb`.","isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.primaryColor","typeLabel":"string | null"},"secondaryColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Secondary colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.secondaryColor","typeLabel":"string | null"},"backgroundColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Background colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.backgroundColor","typeLabel":"string | null"},"surfaceColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Surface colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.surfaceColor","typeLabel":"string | null"},"textColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Text colour (AA contrast on the background).","isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.textColor","typeLabel":"string | null"},"accentColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Accent colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.accentColor","typeLabel":"string | null"},"buttonColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonColor","typeLabel":"string | null"},"buttonTextColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button text colour (AA contrast on the button).","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonTextColor","typeLabel":"string | null"},"buttonBorderColor":{"oneOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^#[0-9a-f]{6}$","description":"Button border colour.","isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.buttonBorderColor","typeLabel":"string | null"},"logoAssetId":{"oneOf":[{"type":"integer","description":"Logo asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoAssetId","typeLabel":"integer\u003cuint64> | null"},"logoDarkAssetId":{"oneOf":[{"type":"integer","description":"Logo for dark backgrounds.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo for dark backgrounds.","isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.logoDarkAssetId","typeLabel":"integer\u003cuint64> | null"},"iconAssetId":{"oneOf":[{"type":"integer","description":"Icon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Icon asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.iconAssetId","typeLabel":"integer\u003cuint64> | null"},"heroImageAssetId":{"oneOf":[{"type":"integer","description":"Hero image asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Hero image asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.heroImageAssetId","typeLabel":"integer\u003cuint64> | null"},"faviconAssetId":{"oneOf":[{"type":"integer","description":"Favicon asset.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Favicon asset.","isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.faviconAssetId","typeLabel":"integer\u003cuint64> | null"},"emailLogoAssetId":{"oneOf":[{"type":"integer","description":"Logo used in emails.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Logo used in emails.","isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.emailLogoAssetId","typeLabel":"integer\u003cuint64> | null"},"fontFamily":{"oneOf":[{"type":"string","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["inter","roboto","open-sans","lato","source-sans-3","system",null],"description":"Font family. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.fontFamily","typeLabel":"enum\u003cstring> | null"},"cornerRadius":{"oneOf":[{"type":"string","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","sm","md","lg","full",null],"description":"Corner radius. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.cornerRadius","typeLabel":"enum\u003cstring> | null"},"extensions":{"oneOf":[{"type":"object","description":"Free-form extension values (keys `x-*`); scanned like every text.","example":{"orderId":"8812","channel":"app"},"additionalProperties":true,"isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Free-form extension values (keys `x-*`); scanned like every text.","isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.extensions","typeLabel":"object | null"},"landing":{"oneOf":[{"type":"object","description":"Consumer landing block; `null` until set.","required":["title","intro","termsUrl","privacyUrl","imprintUrl","supportEmail","supportUrl","footerText","showProviderSearch","look","botProtection"],"properties":{"title":{"oneOf":[{"type":"object","description":"Landing page title (at most 80 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.0","typeLabel":"object"},{"type":"null","description":"Landing page title (at most 80 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.title","typeLabel":"object | null"},"intro":{"oneOf":[{"type":"object","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","example":{"de":"Gültig für **alle** E-Scooter.","en":"Valid for **all** e-scooters."},"properties":{"de":{"type":"string","description":"German Markdown.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English Markdown.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.0","typeLabel":"object"},{"type":"null","description":"Introduction in restricted Markdown (at most 1,000 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.intro","typeLabel":"object | null"},"termsUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your terms URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.termsUrl","typeLabel":"string\u003curi> | null"},"privacyUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your privacy policy URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.privacyUrl","typeLabel":"string\u003curi> | null"},"imprintUrl":{"oneOf":[{"type":"string","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Your imprint URL (https). Required before you create Redemption Links.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.imprintUrl","typeLabel":"string\u003curi> | null"},"supportEmail":{"oneOf":[{"type":"string","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Support email shown to customers.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportEmail","typeLabel":"string\u003cemail> | null"},"supportUrl":{"oneOf":[{"type":"string","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Support URL (https).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.supportUrl","typeLabel":"string\u003curi> | null"},"footerText":{"oneOf":[{"type":"object","description":"Footer text (at most 300 characters per locale).","example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"properties":{"de":{"type":"string","description":"German text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0.en","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.0","typeLabel":"object"},{"type":"null","description":"Footer text (at most 300 characters per locale).","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.footerText","typeLabel":"object | null"},"showProviderSearch":{"type":"boolean","description":"Show the provider search on the landing page.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.showProviderSearch","typeLabel":"boolean"},"look":{"type":"string","enum":["vibrant","soft","bold","clean"],"description":"Landing Look: how colourful the landing pages are. Optional on write (default `vibrant`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.look","typeLabel":"enum\u003cstring>"},"botProtection":{"type":"string","enum":["off","turnstile"],"description":"Bot protection of your Redemption Link landing pages. `turnstile` shows the Cloudflare Turnstile widget and requires its token on the OTP request and the redeem. Optional on write (default `off`); always present on read. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0.botProtection","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.0","typeLabel":"object"},{"type":"null","description":"Consumer landing block; `null` until set.","isRequired":true,"uniqueKey":"data.live.oneOf.0.landing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live.oneOf.0.landing","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.live.oneOf.0","typeLabel":"object"},{"type":"null","description":"Current branding; `null` until the first save.","isRequired":true,"uniqueKey":"data.live.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.live","typeLabel":"object | null"},"liveRevisionNo":{"type":"integer","description":"Number of saves.","isRequired":true,"uniqueKey":"data.liveRevisionNo","typeLabel":"integer"},"pendingChangeRequestId":{"type":"null","description":"Always `null` for Workspace Branding (no approval needed).","isRequired":true,"uniqueKey":"data.pendingChangeRequestId","typeLabel":"null"},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Asset id.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["brand-asset"],"description":"Always `brand-asset`.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].resource","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["logo","logo-dark","icon","hero","favicon","email-logo"],"description":"Asset kind. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"publicUrl":{"type":"string","format":"uri","description":"Public URL.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].publicUrl","typeLabel":"string\u003curi>"},"width":{"oneOf":[{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].height","typeLabel":"integer | null"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assets.items.[INDEX].variants","typeLabel":"object | null"},"_links":{"type":"object","properties":{"self":{"type":"object","description":"The asset.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links.self","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"description":"Links.","isRequired":true,"uniqueKey":"data.assets.items.[INDEX]._links","typeLabel":"object"}},"required":["id","resource","kind","publicUrl","width","height","variants","_links"],"additionalProperties":false,"description":"A referenced brand asset.","uniqueKey":"data.assets.items.[INDEX]","typeLabel":"object"},"description":"Every asset referenced by `live`.","isRequired":true,"uniqueKey":"data.assets","typeLabel":"object[]"},"assetUrls":{"type":"object","properties":{"logo":{"oneOf":[{"type":"object","description":"logo image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.0","typeLabel":"object"},{"type":"null","description":"logo image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logo","typeLabel":"object | null"},"logoDark":{"oneOf":[{"type":"object","description":"logoDark image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.0","typeLabel":"object"},{"type":"null","description":"logoDark image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.logoDark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.logoDark","typeLabel":"object | null"},"icon":{"oneOf":[{"type":"object","description":"icon image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.0","typeLabel":"object"},{"type":"null","description":"icon image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.icon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.icon","typeLabel":"object | null"},"hero":{"oneOf":[{"type":"object","description":"hero image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.0","typeLabel":"object"},{"type":"null","description":"hero image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.hero.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.hero","typeLabel":"object | null"},"favicon":{"oneOf":[{"type":"object","description":"favicon image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.0","typeLabel":"object"},{"type":"null","description":"favicon image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.favicon.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.favicon","typeLabel":"object | null"},"emailLogo":{"oneOf":[{"type":"object","description":"emailLogo image, `null` when unset or not ready.","required":["assetId","url","width","height","variants"],"properties":{"assetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Brand asset id.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.assetId","typeLabel":"integer\u003cuint64>"},"url":{"type":"string","format":"uri","description":"Public URL of the image.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"type":"integer","description":"Width in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","description":"Height in pixels.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.height","typeLabel":"integer"},"variants":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Responsive variants; `null` for now.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0.variants","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.0","typeLabel":"object"},{"type":"null","description":"emailLogo image, `null` when unset or not ready.","isRequired":true,"uniqueKey":"data.assetUrls.emailLogo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assetUrls.emailLogo","typeLabel":"object | null"}},"required":["logo","logoDark","icon","hero","favicon","emailLogo"],"additionalProperties":false,"description":"Render map of the referenced images.","isRequired":true,"uniqueKey":"data.assetUrls","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the resource was created.","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the resource was last changed.","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"_links":{"type":"object","description":"Related resources you may follow (HAL style). A link is present only when you hold the target's permissions.","properties":{"self":{"type":"object","description":"This resource.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"data._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"data._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data._links.self","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data._links","typeLabel":"object"}},"required":["id","resource","partnerId","scope","live","liveRevisionNo","pendingChangeRequestId","assets","assetUrls","createdAt","updatedAt","_links"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"data":{"id":37069,"resource":"branding","partnerId":1069,"scope":"workspace","live":{"primaryColor":"#c8102e","secondaryColor":null,"backgroundColor":"#ffffff","surfaceColor":"#f5f5f5","textColor":"#1a1a1a","accentColor":null,"buttonColor":"#c8102e","buttonTextColor":"#ffffff","buttonBorderColor":null,"logoAssetId":3095,"logoDarkAssetId":null,"iconAssetId":null,"heroImageAssetId":null,"faviconAssetId":null,"emailLogoAssetId":null,"fontFamily":"source-sans-3","cornerRadius":"md","extensions":null,"landing":{"title":{"de":"Ihre Mobilitätsgutscheine","en":"Your mobility vouchers"},"intro":{"de":"Wählen Sie einen Anbieter.","en":"Choose a provider."},"termsUrl":"https://www.example-transit.example.com/vouchers/terms","privacyUrl":"https://www.example-transit.example.com/privacy","imprintUrl":"https://www.example-transit.example.com/imprint","supportEmail":"[email protected]","supportUrl":null,"footerText":null,"showProviderSearch":true,"look":"vibrant","botProtection":"turnstile"}},"liveRevisionNo":3,"pendingChangeRequestId":null,"assets":[{"id":3095,"resource":"brand-asset","kind":"logo","publicUrl":"https://assets.voucher.allride.io/example-transit/3095.png","width":512,"height":128,"variants":null,"_links":{"self":{"href":"https://api.voucher.allride.io/partner/v1/brand-assets/3095","type":"application/json"}}}],"assetUrls":{"logo":{"assetId":3095,"url":"https://assets.voucher.allride.io/example-transit/3095.png","width":512,"height":128,"variants":null},"logoDark":null,"icon":null,"hero":null,"favicon":null,"emailLogo":null},"createdAt":"2026-10-19T14:02:11.418Z","updatedAt":"2026-10-22T08:00:00Z","_links":{"self":{"href":"https://api.voucher.allride.io/partner/v1/branding/workspace","type":"application/json"}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"0859be62-3519-4420-895e-ef9cbd63499f":{"description":"Bad Request","x-error-codes":["malformed-json","invalid-header","data-failed-validation"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"malformed-json":{"title":"malformed-json","value":{"errors":[{"message":"The body is not valid UTF-8 JSON or nests deeper than 32 levels.","statusCode":400,"errorCode":"malformed-json"}]}},"invalid-header":{"title":"invalid-header","value":{"errors":[{"message":"A standard or platform header is malformed or missing; `more.validationErrors[].property` names it.","statusCode":400,"errorCode":"invalid-header"}]}},"data-failed-validation":{"title":"data-failed-validation","value":{"errors":[{"message":"One or more properties or parameters are invalid; each is listed in `more.validationErrors` with its property path and violated constraint. Unknown properties and query parameters are refused as well.","statusCode":400,"errorCode":"data-failed-validation","more":{"validationErrors":[{"property":"name","constraint":"required","message":{"en":"This property is required."}}]}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f561d3ac-76e1-467a-8b4e-1adb0a363c65":{"description":"Unauthorized: the credential is missing or invalid.","x-error-codes":["unauthenticated","token-invalid","token-expired","api-key-invalid"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"unauthenticated":{"title":"unauthenticated","value":{"errors":[{"message":"No credential was sent with the request.","statusCode":401,"errorCode":"unauthenticated"}]}},"token-invalid":{"title":"token-invalid","value":{"errors":[{"message":"The credential cannot be verified for this surface (wrong scheme, signature or credential kind).","statusCode":401,"errorCode":"token-invalid"}]}},"token-expired":{"title":"token-expired","value":{"errors":[{"message":"The dashboard ID token has expired.","statusCode":401,"errorCode":"token-expired"}]}},"api-key-invalid":{"title":"api-key-invalid","value":{"errors":[{"message":"The API key is unknown, revoked, expired, past its roll grace period or belongs to the other environment (`vk_test_` against production or `vk_live_` against the sandbox).","statusCode":401,"errorCode":"api-key-invalid"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"ecf84643-6f97-43ef-969e-be0655b528f6":{"description":"Forbidden: an access gate refused the request.","x-error-codes":["partner-role-missing","partner-suspended","partner-offboarded","api-access-inactive","ip-not-allowed","mfa-required","sso-required","missing-permission","reauthentication-required"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"partner-role-missing":{"title":"partner-role-missing","value":{"errors":[{"message":"Your partner lacks the role (provider or consumer) this surface needs.","statusCode":403,"errorCode":"partner-role-missing","more":{"requiredRole":"consumer"}}]}},"partner-suspended":{"title":"partner-suspended","value":{"errors":[{"message":"Your partner is suspended: writes are refused (billing writes from the dashboard excepted).","statusCode":403,"errorCode":"partner-suspended"}]}},"partner-offboarded":{"title":"partner-offboarded","value":{"errors":[{"message":"Your partner has been offboarded; every route is refused.","statusCode":403,"errorCode":"partner-offboarded"}]}},"api-access-inactive":{"title":"api-access-inactive","value":{"errors":[{"message":"API access of your partner is not active (not yet granted, revoked, or the partner is suspended), so API keys are refused.","statusCode":403,"errorCode":"api-access-inactive"}]}},"ip-not-allowed":{"title":"ip-not-allowed","value":{"errors":[{"message":"The request's source address is not in your IP allowlist while enforcement is on.","statusCode":403,"errorCode":"ip-not-allowed"}]}},"mfa-required":{"title":"mfa-required","value":{"errors":[{"message":"Your partner requires multi-factor authentication for dashboard users.","statusCode":403,"errorCode":"mfa-required"}]}},"sso-required":{"title":"sso-required","value":{"errors":[{"message":"Your partner enforces single sign-on for this user's email domain.","statusCode":403,"errorCode":"sso-required"}]}},"missing-permission":{"title":"missing-permission","value":{"errors":[{"message":"The membership or API key lacks a permission the operation requires, including non-delegable permissions called with an API key.","statusCode":403,"errorCode":"missing-permission","more":{"requiredPermissions":["create-consumer-redemptions"]}}]}},"reauthentication-required":{"title":"reauthentication-required","value":{"errors":[{"message":"The operation needs a sign-in within the last 15 minutes (dashboard users only).","statusCode":403,"errorCode":"reauthentication-required"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"220428bc-205c-4802-96c9-83cd87bef36d":{"description":"Not found.","x-error-codes":["route-not-found","brand-asset-not-found"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"route-not-found":{"title":"route-not-found","value":{"errors":[{"message":"No operation exists for this path.","statusCode":404,"errorCode":"route-not-found"}]}},"brand-asset-not-found":{"title":"brand-asset-not-found","value":{"errors":[{"message":"No brand asset with this id exists in your partner.","statusCode":404,"errorCode":"brand-asset-not-found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6f21fd7a-6dec-4008-8bca-ec7423a17460":{"description":"Conflict","x-error-codes":["landing-legal-urls-required"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"landing-legal-urls-required":{"title":"landing-legal-urls-required","value":{"errors":[{"message":"The change would clear `landing.privacyUrl` or `landing.imprintUrl` while you still have Redemption Links that are not revoked.","statusCode":409,"errorCode":"landing-legal-urls-required"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c22df60e-72c9-46e7-9832-a79e0375e07b":{"description":"Unprocessable Content","x-error-codes":["insufficient-contrast","content-blocked"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"insufficient-contrast":{"title":"insufficient-contrast","value":{"errors":[{"message":"A text and background colour pair does not reach WCAG AA contrast (4.5:1).","statusCode":422,"errorCode":"insufficient-contrast"}]}},"content-blocked":{"title":"content-blocked","value":{"errors":[{"message":"A text you saved breaks a content rule. Each `more.validationErrors` entry names the field (`property`) and the public reason (`constraint`).","statusCode":422,"errorCode":"content-blocked","more":{"validationErrors":[{"property":"landing.intro.de","constraint":"content-markup-not-allowed","message":{"en":"Contains HTML, scripts or template code."}}]}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0249322b-5f54-40be-92c8-4a49e133fbdd":{"description":"Unexpected failure; quote the `requestId`.","x-error-codes":["internal-error"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"internal-error":{"title":"internal-error","value":{"errors":[{"message":"Something went wrong on our side","statusCode":500,"errorCode":"internal-error","requestId":"0c9f2ea5-fe09-463c-8f96-b6cae67800ad"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"555a7d94-3a25-42e8-bb3c-ca598c3bf500":{"description":"Temporarily unavailable; retry after `Retry-After`.","x-error-codes":["service-unavailable","db-unavailable","query-timeout"],"headers":{"X-Request-Id":{"description":"Request id (yours if you sent a valid `X-Request-Id`, else generated).","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying or polling.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error body of every 4xx and 5xx response (`Content-Type: application/json`).","properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","description":"One error. Branch on `errorCode`; ignore members you do not know.","properties":{"message":{"type":"string","description":"Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"statusCode":{"type":"integer","description":"The HTTP status.","isRequired":true,"uniqueKey":"errors.items.[INDEX].statusCode","typeLabel":"integer"},"errorCode":{"type":"string","description":"Stable kebab-case error code, listed in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].errorCode","typeLabel":"string"},"requestId":{"type":"string","description":"5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support.","uniqueKey":"errors.items.[INDEX].requestId","typeLabel":"string"},"more":{"type":"object","additionalProperties":true,"description":"Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog.","properties":{"validationErrors":{"type":"array","items":{"type":"object","description":"One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks).","properties":{"property":{"type":"string","description":"Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].property","typeLabel":"string"},"constraint":{"type":"string","description":"The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].constraint","typeLabel":"string"},"message":{"type":"object","description":"Explanation per locale.","properties":{"en":{"type":"string","description":"English message.","isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.en","typeLabel":"string"},"de":{"type":"string","description":"German message.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message.de","typeLabel":"string"}},"required":["en"],"additionalProperties":false,"isRequired":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].message","typeLabel":"object"},"params":{"type":"object","additionalProperties":true,"description":"Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].params","typeLabel":"object"},"value":{"description":"The rejected value, when it is safe to return.","uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX].value","typeLabel":"any"}},"required":["property","constraint","message"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX].more.validationErrors.items.[INDEX]","typeLabel":"object"},"description":"Invalid properties or parameters.","uniqueKey":"errors.items.[INDEX].more.validationErrors","typeLabel":"object[]"}},"uniqueKey":"errors.items.[INDEX].more","typeLabel":"object"}},"required":["message","statusCode","errorCode"],"additionalProperties":true,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"The errors; in v1 always exactly one.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"service-unavailable":{"title":"service-unavailable","value":{"errors":[{"message":"Something went wrong on our side","statusCode":503,"errorCode":"service-unavailable","requestId":"0c9f2ea5-fe09-463c-8f96-b6cae67800ad"}]}},"db-unavailable":{"title":"db-unavailable","value":{"errors":[{"message":"Something went wrong on our side","statusCode":503,"errorCode":"db-unavailable","requestId":"0c9f2ea5-fe09-463c-8f96-b6cae67800ad"}]}},"query-timeout":{"title":"query-timeout","value":{"errors":[{"message":"Something went wrong on our side","statusCode":503,"errorCode":"query-timeout","requestId":"0c9f2ea5-fe09-463c-8f96-b6cae67800ad"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e665e8eb-c733-4f11-acb6-1852122ca357":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"vk_live_\u003ckeyId>_\u003csecret>","description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","scopes":[],"schemeName":"apiKey"}}},"servers":{"194c8b4a-ee81-4799-8d91-168cc798538c":{"url":"https://api.voucher-staging.allride.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"vk_live_\u003ckeyId>_\u003csecret>","description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi/consumer.v1.json"},"subdomain":"allride-voucher-consumer","siteName":"AllRide Vouchers — Consumer API","title":"Replace workspace branding - AllRide Vouchers — Consumer API","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/partner-workspace-branding-replace","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T10:55:54.410Z","originalFileLocation":"api-reference/partner-workspace-branding-replace.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=\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds. Required permissions: manage-workspace-branding · API keys: allowed\">\u003cmeta data-mint-head name=\"application-name\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Replace workspace branding - AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds. Required permissions: manage-workspace-branding · API keys: allowed\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://allride-voucher-consumer.mintlify.app/_mintlify/api/og/v2?division=Workspace+branding\u0026amp;title=Replace+workspace+branding\u0026amp;description=Replaces+the+complete+branding+content.+No+approval+is+needed%2C+but+every+text+and+URL+passes+the+content+checks+synchronously+%28422+%60content-blocked%60%29.+Clearing+\u0026amp;theme=aa1e578c5c25daaa6c2c70a3\u0026amp;signature=b5ea32970894f4c1d5de2b80fb69103e5cf0e8045a96fd17642b6bffa42dc0df\">\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=\"Replace workspace branding - AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds. Required permissions: manage-workspace-branding · API keys: allowed\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://allride-voucher-consumer.mintlify.app/_mintlify/api/og/v2?division=Workspace+branding\u0026amp;title=Replace+workspace+branding\u0026amp;description=Replaces+the+complete+branding+content.+No+approval+is+needed%2C+but+every+text+and+URL+passes+the+content+checks+synchronously+%28422+%60content-blocked%60%29.+Clearing+\u0026amp;theme=aa1e578c5c25daaa6c2c70a3\u0026amp;signature=b5ea32970894f4c1d5de2b80fb69103e5cf0e8045a96fd17642b6bffa42dc0df\">\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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/partner-workspace-branding-replace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\",\"name\":\"AllRide Vouchers — Consumer API\",\"url\":\"https://allride-voucher-consumer.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/light.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=92f0ea94edcefc1febba871b5ead8cdd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\",\"name\":\"AllRide Vouchers — Consumer API\",\"url\":\"https://allride-voucher-consumer.mintlify.app\",\"publisher\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace#webpage\",\"url\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace\",\"name\":\"Replace workspace branding\",\"description\":\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds. Required permissions: manage-workspace-branding · API keys: allowed\",\"dateModified\":\"2026-11-03T10:55:54.410Z\",\"isPartOf\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspace API\",\"item\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-partner-get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspace branding\",\"item\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-brand-assets-list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Replace workspace branding\",\"item\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace#apireference\",\"headline\":\"Replace workspace branding\",\"name\":\"Replace workspace branding\",\"description\":\"Replaces the complete branding content. No approval is needed, but every text and URL passes the content checks synchronously (422 content-blocked). Clearing landing.privacyUrl or landing.imprintUrl is refused while Redemption Links that are not revoked exist. Answers 201 on the first save and 200 afterwards; landing pages pick up changes within 60 seconds. Required permissions: manage-workspace-branding · API keys: allowed\",\"url\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace\",\"mainEntityOfPage\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/api-reference/partner-workspace-branding-replace#webpage\"},\"dateModified\":\"2026-11-03T10:55:54.410Z\",\"publisher\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AllRide Vouchers — Consumer API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AllRide Vouchers — Consumer API","nav":{"global":null,"versions":[{"version":"v1","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Consumer API","pages":[{"group":"Catalog","pages":[{"title":"List catalog providers","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog providers list","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/providers","href":"/api-reference/consumer-catalog-providers-list"},{"title":"List catalog voucher sets","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog voucher sets list","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/voucher-sets","href":"/api-reference/consumer-catalog-voucher-sets-list"},{"title":"List categories","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog categories list","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/categories","href":"/api-reference/consumer-catalog-categories-list"},{"title":"Get a catalog provider","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog providers get","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/providers/{providerId}","href":"/api-reference/consumer-catalog-providers-get"},{"title":"Get a catalog voucher set","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog voucher sets get","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/voucher-sets/{voucherSetId}","href":"/api-reference/consumer-catalog-voucher-sets-get"},{"title":"Get a category","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog categories get","openapi":"/openapi/consumer.v1.json get /consumer/v1/catalog/categories/{categoryId}","href":"/api-reference/consumer-catalog-categories-get"}]},{"group":"Catalog settings","pages":[{"title":"Update provider toggle and settings","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog providers update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/catalog/providers/{providerId}","href":"/api-reference/consumer-catalog-providers-update"},{"title":"Update voucher set toggle and settings","deprecated":null,"version":null,"sidebarTitle":"Consumer catalog voucher sets update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/catalog/voucher-sets/{voucherSetId}","href":"/api-reference/consumer-catalog-voucher-sets-update"}]},{"group":"Redemptions","pages":[{"title":"List redemptions","deprecated":null,"version":null,"sidebarTitle":"Consumer redemptions list","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemptions","href":"/api-reference/consumer-redemptions-list"},{"title":"Redeem a voucher","deprecated":null,"version":null,"sidebarTitle":"Consumer redemptions create","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemptions","href":"/api-reference/consumer-redemptions-create"},{"title":"Get a redemption","deprecated":null,"version":null,"sidebarTitle":"Consumer redemptions get","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemptions/{redemptionId}","href":"/api-reference/consumer-redemptions-get"},{"title":"Get a redemption batch","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption batches get","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-batches/{redemptionBatchId}","href":"/api-reference/consumer-redemption-batches-get"},{"title":"Void a redemption","deprecated":null,"version":null,"sidebarTitle":"Consumer redemptions void","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemptions/{redemptionId}:void","href":"/api-reference/consumer-redemptions-void"},{"title":"Redeem several vouchers in one request","deprecated":null,"version":null,"sidebarTitle":"Consumer redemptions batch","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemptions:batch","href":"/api-reference/consumer-redemptions-batch"}]},{"group":"Redemption entities","pages":[{"title":"List redemption entities","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities list","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-entities","href":"/api-reference/consumer-redemption-entities-list"},{"title":"Create a redemption entity","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities create","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-entities","href":"/api-reference/consumer-redemption-entities-create"},{"title":"Get a redemption entity","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities get","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-entities/{redemptionEntityId}","href":"/api-reference/consumer-redemption-entities-get"},{"title":"Update a redemption entity","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/redemption-entities/{redemptionEntityId}","href":"/api-reference/consumer-redemption-entities-update"},{"title":"Block a redemption entity","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities block","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-entities/{redemptionEntityId}:block","href":"/api-reference/consumer-redemption-entities-block"},{"title":"Erase a redemption entity (GDPR)","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities erase","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-entities/{redemptionEntityId}:erase","href":"/api-reference/consumer-redemption-entities-erase"},{"title":"Unblock a redemption entity","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption entities unblock","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-entities/{redemptionEntityId}:unblock","href":"/api-reference/consumer-redemption-entities-unblock"}]},{"group":"Redemption links","pages":[{"title":"List redemption links","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links list","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-links","href":"/api-reference/consumer-redemption-links-list"},{"title":"Create a redemption link","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links create","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-links","href":"/api-reference/consumer-redemption-links-create"},{"title":"Get a redemption link","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links get","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-links/{redemptionLinkId}","href":"/api-reference/consumer-redemption-links-get"},{"title":"Preview a link's catalog","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links catalog","openapi":"/openapi/consumer.v1.json get /consumer/v1/redemption-links/{redemptionLinkId}/catalog","href":"/api-reference/consumer-redemption-links-catalog"},{"title":"Update a redemption link","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/redemption-links/{redemptionLinkId}","href":"/api-reference/consumer-redemption-links-update"},{"title":"Revoke a redemption link","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links revoke","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-links/{redemptionLinkId}:revoke","href":"/api-reference/consumer-redemption-links-revoke"},{"title":"Create redemption links in bulk","deprecated":null,"version":null,"sidebarTitle":"Consumer redemption links batch","openapi":"/openapi/consumer.v1.json post /consumer/v1/redemption-links:batch","href":"/api-reference/consumer-redemption-links-batch"}]},{"group":"Email (SMTP and templates)","pages":[{"title":"List email templates","deprecated":null,"version":null,"sidebarTitle":"Partner email templates list","openapi":"/openapi/consumer.v1.json get /partner/v1/email-templates","href":"/api-reference/partner-email-templates-list"},{"title":"Create an email template","deprecated":null,"version":null,"sidebarTitle":"Partner email templates create","openapi":"/openapi/consumer.v1.json post /partner/v1/email-templates","href":"/api-reference/partner-email-templates-create"},{"title":"Get email OTP settings","deprecated":null,"version":null,"sidebarTitle":"Consumer email otp settings get","openapi":"/openapi/consumer.v1.json get /consumer/v1/email-otp-settings","href":"/api-reference/consumer-email-otp-settings-get"},{"title":"Get email OTP readiness","deprecated":null,"version":null,"sidebarTitle":"Consumer email otp readiness get","openapi":"/openapi/consumer.v1.json get /consumer/v1/email-otp-settings/readiness","href":"/api-reference/consumer-email-otp-readiness-get"},{"title":"Get the SMTP configuration","deprecated":null,"version":null,"sidebarTitle":"Partner smtp configuration get","openapi":"/openapi/consumer.v1.json get /partner/v1/smtp-configuration","href":"/api-reference/partner-smtp-configuration-get"},{"title":"Get an email template","deprecated":null,"version":null,"sidebarTitle":"Partner email templates get","openapi":"/openapi/consumer.v1.json get /partner/v1/email-templates/{emailTemplateId}","href":"/api-reference/partner-email-templates-get"},{"title":"Render a saved template preview","deprecated":null,"version":null,"sidebarTitle":"Partner email templates preview","openapi":"/openapi/consumer.v1.json get /partner/v1/email-templates/{emailTemplateId}/preview","href":"/api-reference/partner-email-templates-preview"},{"title":"Get a template variable contract","deprecated":null,"version":null,"sidebarTitle":"Partner email template contracts get","openapi":"/openapi/consumer.v1.json get /partner/v1/email-template-contracts/{purpose}","href":"/api-reference/partner-email-template-contracts-get"},{"title":"Update email OTP settings","deprecated":null,"version":null,"sidebarTitle":"Consumer email otp settings update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/email-otp-settings","href":"/api-reference/consumer-email-otp-settings-update"},{"title":"Create or replace the SMTP configuration","deprecated":null,"version":null,"sidebarTitle":"Partner smtp configuration replace","openapi":"/openapi/consumer.v1.json put /partner/v1/smtp-configuration","href":"/api-reference/partner-smtp-configuration-replace"},{"title":"Update a draft email template","deprecated":null,"version":null,"sidebarTitle":"Partner email templates update","openapi":"/openapi/consumer.v1.json patch /partner/v1/email-templates/{emailTemplateId}","href":"/api-reference/partner-email-templates-update"},{"title":"Activate an email template","deprecated":null,"version":null,"sidebarTitle":"Partner email templates activate","openapi":"/openapi/consumer.v1.json post /partner/v1/email-templates/{emailTemplateId}:activate","href":"/api-reference/partner-email-templates-activate"},{"title":"Archive an email template","deprecated":null,"version":null,"sidebarTitle":"Partner email templates archive","openapi":"/openapi/consumer.v1.json post /partner/v1/email-templates/{emailTemplateId}:archive","href":"/api-reference/partner-email-templates-archive"},{"title":"Render an unsaved template preview","deprecated":null,"version":null,"sidebarTitle":"Partner email templates preview draft","openapi":"/openapi/consumer.v1.json post /partner/v1/email-templates:preview","href":"/api-reference/partner-email-templates-preview-draft"},{"title":"Verify SMTP and send a test email","deprecated":null,"version":null,"sidebarTitle":"Partner smtp configuration verify","openapi":"/openapi/consumer.v1.json post /partner/v1/smtp-configuration:verify","href":"/api-reference/partner-smtp-configuration-verify"}]},{"group":"Analytics","pages":[{"title":"Get redemption statistics","deprecated":null,"version":null,"sidebarTitle":"Consumer analytics redemption stats","openapi":"/openapi/consumer.v1.json get /consumer/v1/analytics/redemption-stats","href":"/api-reference/consumer-analytics-redemption-stats"},{"title":"Get entity statistics","deprecated":null,"version":null,"sidebarTitle":"Consumer analytics entity stats","openapi":"/openapi/consumer.v1.json get /consumer/v1/analytics/entity-stats","href":"/api-reference/consumer-analytics-entity-stats"},{"title":"Get redemption link funnel statistics","deprecated":null,"version":null,"sidebarTitle":"Consumer analytics link stats","openapi":"/openapi/consumer.v1.json get /consumer/v1/analytics/link-stats","href":"/api-reference/consumer-analytics-link-stats"},{"title":"Get the analytics overview","deprecated":null,"version":null,"sidebarTitle":"Consumer analytics overview","openapi":"/openapi/consumer.v1.json get /consumer/v1/analytics/overview","href":"/api-reference/consumer-analytics-overview"}]},{"group":"Billing","pages":[{"title":"List billing contacts","deprecated":null,"version":null,"sidebarTitle":"Consumer billing contacts list","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/contacts","href":"/api-reference/consumer-billing-contacts-list"},{"title":"List payment methods","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payment methods list","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/payment-methods","href":"/api-reference/consumer-billing-payment-methods-list"},{"title":"List invoices","deprecated":null,"version":null,"sidebarTitle":"Consumer billing invoices list","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/invoices","href":"/api-reference/consumer-billing-invoices-list"},{"title":"List invoice lines","deprecated":null,"version":null,"sidebarTitle":"Consumer billing invoices lines","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/invoices/{invoiceId}/lines","href":"/api-reference/consumer-billing-invoices-lines"},{"title":"List payments","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payments list","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/payments","href":"/api-reference/consumer-billing-payments-list"},{"title":"List usage lines of a month","deprecated":null,"version":null,"sidebarTitle":"Consumer billing usage lines","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/usage/lines","href":"/api-reference/consumer-billing-usage-lines"},{"title":"Add a billing contact","deprecated":null,"version":null,"sidebarTitle":"Consumer billing contacts create","openapi":"/openapi/consumer.v1.json post /consumer/v1/billing/contacts","href":"/api-reference/consumer-billing-contacts-create"},{"title":"Get the billing account","deprecated":null,"version":null,"sidebarTitle":"Consumer billing account get","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/account","href":"/api-reference/consumer-billing-account-get"},{"title":"Get a payment method","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payment methods get","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/payment-methods/{paymentMethodId}","href":"/api-reference/consumer-billing-payment-methods-get"},{"title":"Get an invoice","deprecated":null,"version":null,"sidebarTitle":"Consumer billing invoices get","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/invoices/{invoiceId}","href":"/api-reference/consumer-billing-invoices-get"},{"title":"Download an invoice document","deprecated":null,"version":null,"sidebarTitle":"Consumer billing invoices document","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/invoices/{invoiceId}/document","href":"/api-reference/consumer-billing-invoices-document"},{"title":"Get the usage estimate of a month","deprecated":null,"version":null,"sidebarTitle":"Consumer billing usage get","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/usage","href":"/api-reference/consumer-billing-usage-get"},{"title":"Get the billing balance","deprecated":null,"version":null,"sidebarTitle":"Consumer billing balance get","openapi":"/openapi/consumer.v1.json get /consumer/v1/billing/balance","href":"/api-reference/consumer-billing-balance-get"},{"title":"Update the billing account","deprecated":null,"version":null,"sidebarTitle":"Consumer billing account update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/billing/account","href":"/api-reference/consumer-billing-account-update"},{"title":"Update a billing contact","deprecated":null,"version":null,"sidebarTitle":"Consumer billing contacts update","openapi":"/openapi/consumer.v1.json patch /consumer/v1/billing/contacts/{billingContactId}","href":"/api-reference/consumer-billing-contacts-update"},{"title":"Resend an invoice","deprecated":null,"version":null,"sidebarTitle":"Consumer billing invoices resend","openapi":"/openapi/consumer.v1.json post /consumer/v1/billing/invoices/{invoiceId}:resend","href":"/api-reference/consumer-billing-invoices-resend"},{"title":"Make a payment method the default","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payment methods make default","openapi":"/openapi/consumer.v1.json post /consumer/v1/billing/payment-methods/{paymentMethodId}:make-default","href":"/api-reference/consumer-billing-payment-methods-make-default"},{"title":"Remove a payment method","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payment methods remove","openapi":"/openapi/consumer.v1.json post /consumer/v1/billing/payment-methods/{paymentMethodId}:remove","href":"/api-reference/consumer-billing-payment-methods-remove"},{"title":"Start a SEPA Direct Debit mandate setup","deprecated":null,"version":null,"sidebarTitle":"Consumer billing payment methods setup sepa debit","openapi":"/openapi/consumer.v1.json post /consumer/v1/billing/payment-methods:setup-sepa-debit","href":"/api-reference/consumer-billing-payment-methods-setup-sepa-debit"},{"title":"Remove a billing contact","deprecated":null,"version":null,"sidebarTitle":"Consumer billing contacts delete","openapi":"/openapi/consumer.v1.json delete /consumer/v1/billing/contacts/{billingContactId}","href":"/api-reference/consumer-billing-contacts-delete"}]},{"group":"Pricing","pages":[{"title":"List Price Terms of visible voucher sets","deprecated":null,"version":null,"sidebarTitle":"Consumer pricing voucher sets list","openapi":"/openapi/consumer.v1.json get /consumer/v1/pricing/voucher-sets","href":"/api-reference/consumer-pricing-voucher-sets-list"},{"title":"List Price Acceptances","deprecated":null,"version":null,"sidebarTitle":"Consumer pricing acceptances list","openapi":"/openapi/consumer.v1.json get /consumer/v1/pricing/acceptances","href":"/api-reference/consumer-pricing-acceptances-list"},{"title":"Accept Price Terms","deprecated":null,"version":null,"sidebarTitle":"Consumer pricing acceptances create","openapi":"/openapi/consumer.v1.json post /consumer/v1/pricing/acceptances","href":"/api-reference/consumer-pricing-acceptances-create"},{"title":"Get the Price Terms of a voucher set","deprecated":null,"version":null,"sidebarTitle":"Consumer pricing voucher sets get","openapi":"/openapi/consumer.v1.json get /consumer/v1/pricing/voucher-sets/{voucherSetId}","href":"/api-reference/consumer-pricing-voucher-sets-get"},{"title":"Get the pricing summary","deprecated":null,"version":null,"sidebarTitle":"Consumer pricing summary get","openapi":"/openapi/consumer.v1.json get /consumer/v1/pricing/summary","href":"/api-reference/consumer-pricing-summary-get"}]}]},{"group":"Workspace API","pages":[{"group":"Partner","pages":[{"title":"Get your partner","deprecated":null,"version":null,"sidebarTitle":"Partner partner get","openapi":"/openapi/consumer.v1.json get /partner/v1/partner","href":"/api-reference/partner-partner-get"},{"title":"Get the calling principal","deprecated":null,"version":null,"sidebarTitle":"Partner principal get","openapi":"/openapi/consumer.v1.json get /partner/v1/principal","href":"/api-reference/partner-principal-get"},{"title":"Get the API access status","deprecated":null,"version":null,"sidebarTitle":"Partner api access get","openapi":"/openapi/consumer.v1.json get /partner/v1/api-access","href":"/api-reference/partner-api-access-get"},{"title":"Get developer reference information","deprecated":null,"version":null,"sidebarTitle":"Partner developer reference get","openapi":"/openapi/consumer.v1.json get /partner/v1/developer-reference","href":"/api-reference/partner-developer-reference-get"},{"title":"List selectable time zones","deprecated":null,"version":null,"sidebarTitle":"Partner timezones list","openapi":"/openapi/consumer.v1.json get /partner/v1/timezones","href":"/api-reference/partner-timezones-list"},{"title":"Update general information","deprecated":null,"version":null,"sidebarTitle":"Partner partner update","openapi":"/openapi/consumer.v1.json patch /partner/v1/partner","href":"/api-reference/partner-partner-update"},{"title":"Update security settings","deprecated":null,"version":null,"sidebarTitle":"Partner partner update settings","openapi":"/openapi/consumer.v1.json patch /partner/v1/partner/settings","href":"/api-reference/partner-partner-update-settings"},{"title":"Request API access","deprecated":null,"version":null,"sidebarTitle":"Partner api access request","openapi":"/openapi/consumer.v1.json post /partner/v1/api-access:request","href":"/api-reference/partner-api-access-request"}]},{"group":"Members","pages":[{"title":"List members","deprecated":null,"version":null,"sidebarTitle":"Partner members list","openapi":"/openapi/consumer.v1.json get /partner/v1/members","href":"/api-reference/partner-members-list"},{"title":"Invite a member","deprecated":null,"version":null,"sidebarTitle":"Partner members create","openapi":"/openapi/consumer.v1.json post /partner/v1/members","href":"/api-reference/partner-members-create"},{"title":"Get a member","deprecated":null,"version":null,"sidebarTitle":"Partner members get","openapi":"/openapi/consumer.v1.json get /partner/v1/members/{partnerMembershipId}","href":"/api-reference/partner-members-get"},{"title":"Change a member's direct permissions","deprecated":null,"version":null,"sidebarTitle":"Partner members update","openapi":"/openapi/consumer.v1.json patch /partner/v1/members/{partnerMembershipId}","href":"/api-reference/partner-members-update"},{"title":"Remove a member or revoke an invitation","deprecated":null,"version":null,"sidebarTitle":"Partner members remove","openapi":"/openapi/consumer.v1.json post /partner/v1/members/{partnerMembershipId}:remove","href":"/api-reference/partner-members-remove"},{"title":"Resend an invitation","deprecated":null,"version":null,"sidebarTitle":"Partner members resend invitation","openapi":"/openapi/consumer.v1.json post /partner/v1/members/{partnerMembershipId}:resend-invitation","href":"/api-reference/partner-members-resend-invitation"},{"title":"Suspend a member","deprecated":null,"version":null,"sidebarTitle":"Partner members suspend","openapi":"/openapi/consumer.v1.json post /partner/v1/members/{partnerMembershipId}:suspend","href":"/api-reference/partner-members-suspend"},{"title":"Unsuspend a member","deprecated":null,"version":null,"sidebarTitle":"Partner members unsuspend","openapi":"/openapi/consumer.v1.json post /partner/v1/members/{partnerMembershipId}:unsuspend","href":"/api-reference/partner-members-unsuspend"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":null,"version":null,"sidebarTitle":"Partner groups list","openapi":"/openapi/consumer.v1.json get /partner/v1/groups","href":"/api-reference/partner-groups-list"},{"title":"List the members of a group","deprecated":null,"version":null,"sidebarTitle":"Partner groups members","openapi":"/openapi/consumer.v1.json get /partner/v1/groups/{groupId}/members","href":"/api-reference/partner-groups-members"},{"title":"List permissions","deprecated":null,"version":null,"sidebarTitle":"Partner permissions list","openapi":"/openapi/consumer.v1.json get /partner/v1/permissions","href":"/api-reference/partner-permissions-list"},{"title":"Create a group","deprecated":null,"version":null,"sidebarTitle":"Partner groups create","openapi":"/openapi/consumer.v1.json post /partner/v1/groups","href":"/api-reference/partner-groups-create"},{"title":"Get a group","deprecated":null,"version":null,"sidebarTitle":"Partner groups get","openapi":"/openapi/consumer.v1.json get /partner/v1/groups/{groupId}","href":"/api-reference/partner-groups-get"},{"title":"Update a group","deprecated":null,"version":null,"sidebarTitle":"Partner groups update","openapi":"/openapi/consumer.v1.json patch /partner/v1/groups/{groupId}","href":"/api-reference/partner-groups-update"},{"title":"Delete a group","deprecated":null,"version":null,"sidebarTitle":"Partner groups delete","openapi":"/openapi/consumer.v1.json delete /partner/v1/groups/{groupId}","href":"/api-reference/partner-groups-delete"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"sidebarTitle":"Partner api keys list","openapi":"/openapi/consumer.v1.json get /partner/v1/api-keys","href":"/api-reference/partner-api-keys-list"},{"title":"Create an API key","deprecated":null,"version":null,"sidebarTitle":"Partner api keys create","openapi":"/openapi/consumer.v1.json post /partner/v1/api-keys","href":"/api-reference/partner-api-keys-create"},{"title":"Get an API key","deprecated":null,"version":null,"sidebarTitle":"Partner api keys get","openapi":"/openapi/consumer.v1.json get /partner/v1/api-keys/{apiKeyId}","href":"/api-reference/partner-api-keys-get"},{"title":"Rename an API key","deprecated":null,"version":null,"sidebarTitle":"Partner api keys update","openapi":"/openapi/consumer.v1.json patch /partner/v1/api-keys/{apiKeyId}","href":"/api-reference/partner-api-keys-update"},{"title":"Revoke an API key","deprecated":null,"version":null,"sidebarTitle":"Partner api keys revoke","openapi":"/openapi/consumer.v1.json post /partner/v1/api-keys/{apiKeyId}:revoke","href":"/api-reference/partner-api-keys-revoke"},{"title":"Roll an API key","deprecated":null,"version":null,"sidebarTitle":"Partner api keys roll","openapi":"/openapi/consumer.v1.json post /partner/v1/api-keys/{apiKeyId}:roll","href":"/api-reference/partner-api-keys-roll"}]},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints list","openapi":"/openapi/consumer.v1.json get /partner/v1/webhook-endpoints","href":"/api-reference/partner-webhook-endpoints-list"},{"title":"List webhook event types","deprecated":null,"version":null,"sidebarTitle":"Partner webhook event types list","openapi":"/openapi/consumer.v1.json get /partner/v1/webhook-event-types","href":"/api-reference/partner-webhook-event-types-list"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints create","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints","href":"/api-reference/partner-webhook-endpoints-create"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints get","openapi":"/openapi/consumer.v1.json get /partner/v1/webhook-endpoints/{webhookEndpointId}","href":"/api-reference/partner-webhook-endpoints-get"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints update","openapi":"/openapi/consumer.v1.json patch /partner/v1/webhook-endpoints/{webhookEndpointId}","href":"/api-reference/partner-webhook-endpoints-update"},{"title":"Pause a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints pause","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:pause","href":"/api-reference/partner-webhook-endpoints-pause"},{"title":"Resume a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints resume","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:resume","href":"/api-reference/partner-webhook-endpoints-resume"},{"title":"Rotate the first signing secret","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints rotate first secret","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:rotate-first-secret","href":"/api-reference/partner-webhook-endpoints-rotate-first-secret"},{"title":"Rotate the second signing secret","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints rotate second secret","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:rotate-second-secret","href":"/api-reference/partner-webhook-endpoints-rotate-second-secret"},{"title":"Send a test event","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints send test event","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event","href":"/api-reference/partner-webhook-endpoints-send-test-event"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints delete","openapi":"/openapi/consumer.v1.json delete /partner/v1/webhook-endpoints/{webhookEndpointId}","href":"/api-reference/partner-webhook-endpoints-delete"}]},{"group":"Webhook deliveries","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"sidebarTitle":"Partner webhook deliveries list","openapi":"/openapi/consumer.v1.json get /partner/v1/webhook-deliveries","href":"/api-reference/partner-webhook-deliveries-list"},{"title":"Get a webhook delivery","deprecated":null,"version":null,"sidebarTitle":"Partner webhook deliveries get","openapi":"/openapi/consumer.v1.json get /partner/v1/webhook-deliveries/{webhookDeliveryId}","href":"/api-reference/partner-webhook-deliveries-get"},{"title":"Replay a webhook delivery","deprecated":null,"version":null,"sidebarTitle":"Partner webhook deliveries replay","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-deliveries/{webhookDeliveryId}:replay","href":"/api-reference/partner-webhook-deliveries-replay"},{"title":"Replay failed deliveries of an endpoint","deprecated":null,"version":null,"sidebarTitle":"Partner webhook endpoints replay failed","openapi":"/openapi/consumer.v1.json post /partner/v1/webhook-endpoints/{webhookEndpointId}:replay-failed","href":"/api-reference/partner-webhook-endpoints-replay-failed"}]},{"group":"IP allowlist","pages":[{"title":"List IP allowlist entries","deprecated":null,"version":null,"sidebarTitle":"Partner ip allowlist list","openapi":"/openapi/consumer.v1.json get /partner/v1/ip-allowlist","href":"/api-reference/partner-ip-allowlist-list"},{"title":"Add an IP allowlist entry","deprecated":null,"version":null,"sidebarTitle":"Partner ip allowlist create","openapi":"/openapi/consumer.v1.json post /partner/v1/ip-allowlist","href":"/api-reference/partner-ip-allowlist-create"},{"title":"Relabel an IP allowlist entry","deprecated":null,"version":null,"sidebarTitle":"Partner ip allowlist update","openapi":"/openapi/consumer.v1.json patch /partner/v1/ip-allowlist/{ipAllowlistEntryId}","href":"/api-reference/partner-ip-allowlist-update"},{"title":"Remove an IP allowlist entry","deprecated":null,"version":null,"sidebarTitle":"Partner ip allowlist delete","openapi":"/openapi/consumer.v1.json delete /partner/v1/ip-allowlist/{ipAllowlistEntryId}","href":"/api-reference/partner-ip-allowlist-delete"}]},{"group":"Custom domains","pages":[{"title":"List custom domains","deprecated":null,"version":null,"sidebarTitle":"Partner custom domains list","openapi":"/openapi/consumer.v1.json get /partner/v1/custom-domains","href":"/api-reference/partner-custom-domains-list"},{"title":"Add a custom domain","deprecated":null,"version":null,"sidebarTitle":"Partner custom domains create","openapi":"/openapi/consumer.v1.json post /partner/v1/custom-domains","href":"/api-reference/partner-custom-domains-create"},{"title":"Get a custom domain","deprecated":null,"version":null,"sidebarTitle":"Partner custom domains get","openapi":"/openapi/consumer.v1.json get /partner/v1/custom-domains/{customDomainId}","href":"/api-reference/partner-custom-domains-get"},{"title":"Re-check a custom domain","deprecated":null,"version":null,"sidebarTitle":"Partner custom domains refresh","openapi":"/openapi/consumer.v1.json post /partner/v1/custom-domains/{customDomainId}:refresh","href":"/api-reference/partner-custom-domains-refresh"},{"title":"Delete a custom domain","deprecated":null,"version":null,"sidebarTitle":"Partner custom domains delete","openapi":"/openapi/consumer.v1.json delete /partner/v1/custom-domains/{customDomainId}","href":"/api-reference/partner-custom-domains-delete"}]},{"group":"Workspace branding","pages":[{"title":"List brand assets","deprecated":null,"version":null,"sidebarTitle":"Partner brand assets list","openapi":"/openapi/consumer.v1.json get /partner/v1/brand-assets","href":"/api-reference/partner-brand-assets-list"},{"title":"Create a brand asset","deprecated":null,"version":null,"sidebarTitle":"Partner brand assets create","openapi":"/openapi/consumer.v1.json post /partner/v1/brand-assets","href":"/api-reference/partner-brand-assets-create"},{"title":"Get workspace branding","deprecated":null,"version":null,"sidebarTitle":"Partner workspace branding get","openapi":"/openapi/consumer.v1.json get /partner/v1/branding/workspace","href":"/api-reference/partner-workspace-branding-get"},{"title":"Get a brand asset","description":"Returns one asset; poll it after `:complete` until `ready` or `rejected`.\n\n**Required permissions:** `view-profile` · **API keys:** allowed","deprecated":null,"version":null,"sidebarTitle":"Partner brand assets get","openapi":"/openapi/consumer.v1.json get /partner/v1/brand-assets/{brandAssetId}","href":"/api-reference/partner-brand-assets-get"},{"title":"Replace workspace branding","deprecated":null,"version":null,"sidebarTitle":"Partner workspace branding replace","openapi":"/openapi/consumer.v1.json put /partner/v1/branding/workspace","href":"/api-reference/partner-workspace-branding-replace"},{"title":"Complete a brand asset upload","description":"Confirms the upload. The image is then checked, re-encoded and published asynchronously (`processing` → `ready` or `rejected`).\n\n**Required permissions:** `manage-workspace-branding` · **API keys:** allowed","deprecated":null,"version":null,"sidebarTitle":"Partner brand assets complete","openapi":"/openapi/consumer.v1.json post /partner/v1/brand-assets/{brandAssetId}:complete","href":"/api-reference/partner-brand-assets-complete"},{"title":"Delete a brand asset","deprecated":null,"version":null,"sidebarTitle":"Partner brand assets delete","openapi":"/openapi/consumer.v1.json delete /partner/v1/brand-assets/{brandAssetId}","href":"/api-reference/partner-brand-assets-delete"}]},{"group":"Single sign-on","pages":[{"title":"List SSO connections","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections list","openapi":"/openapi/consumer.v1.json get /partner/v1/sso-connections","href":"/api-reference/partner-sso-connections-list"},{"title":"Create an SSO connection","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections create","openapi":"/openapi/consumer.v1.json post /partner/v1/sso-connections","href":"/api-reference/partner-sso-connections-create"},{"title":"Get an SSO connection","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections get","openapi":"/openapi/consumer.v1.json get /partner/v1/sso-connections/{ssoConnectionId}","href":"/api-reference/partner-sso-connections-get"},{"title":"Update an SSO connection","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections update","openapi":"/openapi/consumer.v1.json patch /partner/v1/sso-connections/{ssoConnectionId}","href":"/api-reference/partner-sso-connections-update"},{"title":"Activate an SSO connection","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections activate","openapi":"/openapi/consumer.v1.json post /partner/v1/sso-connections/{ssoConnectionId}:activate","href":"/api-reference/partner-sso-connections-activate"},{"title":"Deactivate an SSO connection","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections deactivate","openapi":"/openapi/consumer.v1.json post /partner/v1/sso-connections/{ssoConnectionId}:deactivate","href":"/api-reference/partner-sso-connections-deactivate"},{"title":"Verify SSO email domains","deprecated":null,"version":null,"sidebarTitle":"Partner sso connections verify","openapi":"/openapi/consumer.v1.json post /partner/v1/sso-connections/{ssoConnectionId}:verify","href":"/api-reference/partner-sso-connections-verify"}]},{"group":"Audit log","pages":[{"title":"List audit events","deprecated":null,"version":null,"sidebarTitle":"Partner audit events list","openapi":"/openapi/consumer.v1.json get /partner/v1/audit-events","href":"/api-reference/partner-audit-events-list"},{"title":"Get an audit event","deprecated":null,"version":null,"sidebarTitle":"Partner audit events get","openapi":"/openapi/consumer.v1.json get /partner/v1/audit-events/{auditEventId}","href":"/api-reference/partner-audit-events-get"}]}]}]},{"tab":"Webhook events","pages":[{"title":"Webhook events","href":"/webhooks/events/redemption-created"}]}]}]},"basePath":"","title":"Replace workspace branding - AllRide Vouchers — Consumer API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}