Replace workspace branding

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

PUT /partner/v1/branding/workspace

Replace workspace branding

cURL

curl --request PUT \
  --url https://api.voucher-staging.allride.io/partner/v1/branding/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "[e-mail]",
    "supportUrl": null,
    "footerText": null,
    "showProviderSearch": true,
    "look": "vibrant",
    "botProtection": "turnstile"
  }
}
'

200

default

{
  "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": "[e-mail]",
        "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"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Body

application/json

Workspace Branding content.

primaryColor · string | null · required

Primary colour #rrggbb.

Pattern: ^#[0-9a-f]{6}$

secondaryColor · string | null · required

Secondary colour.

Pattern: ^#[0-9a-f]{6}$

backgroundColor · string | null · required

Background colour.

Pattern: ^#[0-9a-f]{6}$

surfaceColor · string | null · required

Surface colour.

Pattern: ^#[0-9a-f]{6}$

textColor · string | null · required

Text colour (AA contrast on the background).

Pattern: ^#[0-9a-f]{6}$

accentColor · string | null · required

Accent colour.

Pattern: ^#[0-9a-f]{6}$

buttonColor · string | null · required

Button colour.

Pattern: ^#[0-9a-f]{6}$

buttonTextColor · string | null · required

Button text colour (AA contrast on the button).

Pattern: ^#[0-9a-f]{6}$

buttonBorderColor · string | null · required

Button border colour.

Pattern: ^#[0-9a-f]{6}$

logoAssetId · integer<uint64> | null · required

Logo asset.

Required range: 0 <= x <= 18446744073709552000

logoDarkAssetId · integer<uint64> | null · required

Logo for dark backgrounds.

Required range: 0 <= x <= 18446744073709552000

iconAssetId · integer<uint64> | null · required

Icon asset.

Required range: 0 <= x <= 18446744073709552000

heroImageAssetId · integer<uint64> | null · required

Hero image asset.

Required range: 0 <= x <= 18446744073709552000

faviconAssetId · integer<uint64> | null · required

Favicon asset.

Required range: 0 <= x <= 18446744073709552000

emailLogoAssetId · integer<uint64> | null · required

Logo used in emails.

Required range: 0 <= x <= 18446744073709552000

fontFamily · enum<string> | null · required

Font family. Treat as an open set: new values may be added.

Available options: inter, roboto, open-sans, lato, source-sans-3, system, null

cornerRadius · enum<string> | null · required

Corner radius. Treat as an open set: new values may be added.

Available options: none, sm, md, lg, full, null

extensions · object | null · required

Free-form extension values (keys x-*); scanned like every text.

Example:

{ "orderId": "8812", "channel": "app" }

landing · object | null · required

Consumer landing block; null until set.

Show child attributes

Response

200

application/json

Saved: every later save.

Single-object envelope around a WorkspaceBranding.

data · object · required

Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails.

Show child attributes