Update provider toggle and settings

Turns a provider on or off for you and edits your provider setting (JSON Merge Patch). The setting is created on the first save. Turning the provider off makes all its sets answer 409 voucher-set-unavailable on redeem. Changing autoEnableNewVoucherSets keeps the current toggle of every set already visible. See Catalog and toggles.

Required permissions: manage-consumer-catalog · API keys: allowed

PATCH /consumer/v1/catalog/providers/{providerId}

cURL

disable

curl --request PATCH \
  --url https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "setting": {
    "enabled": false
  }
}
'

200

default

{
  "data": {
    "id": 1030,
    "resource": "consumer-catalog-provider",
    "slug": "acme-scooters",
    "availability": "active",
    "voucherSetCounts": {
      "upcoming": 1,
      "active": 1,
      "deactivationScheduled": 0
    },
    "nextActiveFrom": "2026-11-01T00:00:00Z",
    "earliestDeactivateAt": null,
    "profile": {
      "displayName": {
        "de": "Acme Scooters",
        "en": "Acme Scooters"
      },
      "tagline": {
        "de": "E-Scooter und E-Bikes",
        "en": "E-scooters and e-bikes"
      },
      "description": null,
      "termsText": null,
      "termsUrl": "https://acme-scooters.example.com/terms",
      "privacyUrl": "https://acme-scooters.example.com/privacy",
      "websiteUrl": "https://acme-scooters.example.com",
      "supportUrl": null,
      "appLinks": {
        "appStoreUrl": "https://apps.apple.com/app/id0000000001",
        "playStoreUrl": null
      },
      "defaultCategoryId": 7017,
      "countries": [
        "DE"
      ]
    },
    "profileRevisionNo": 2,
    "listingBranding": {
      "primaryColor": "#14d0e8",
      "secondaryColor": null,
      "backgroundColor": "#0b1f33",
      "surfaceColor": null,
      "textColor": "#ffffff",
      "accentColor": null,
      "buttonColor": "#14d0e8",
      "buttonTextColor": "#0b1f33",
      "buttonBorderColor": null,
      "logoAssetId": 3095,
      "logoDarkAssetId": null,
      "iconAssetId": null,
      "heroImageAssetId": null,
      "faviconAssetId": null,
      "emailLogoAssetId": null,
      "fontFamily": "inter",
      "cornerRadius": "md",
      "extensions": null,
      "assetUrls": {
        "logo": {
          "assetId": 3095,
          "url": "https://assets.voucher.allride.io/acme-scooters/3095.png",
          "width": 320,
          "height": 80,
          "variants": null
        },
        "logoDark": null,
        "icon": null,
        "hero": null
      }
    },
    "providerToggle": true,
    "featured": true,
    "effectiveCategoryId": 7017,
    "setting": {
      "enabled": true,
      "autoEnableNewVoucherSets": true,
      "position": 1,
      "featured": true,
      "categoryOverrideId": null,
      "settings": {
        "schemaVersion": 1,
        "minClientVersion": "3.0.24"
      },
      "externalRef": "3",
      "updatedAt": "2026-10-20T10:00:00Z"
    },
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
        "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.

Path Parameters

providerId · integer<uint64> · required

Id of the provider partner. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

JSON Merge Patch of your provider setting; setting is merged recursively.

setting · object

Fields to change.

Show child attributes

Response

200

application/json

OK

Single-object envelope around a ConsumerCatalogProvider.

data · object · required

A provider with at least one voucher set visible to you, with your setting.

Show child attributes