> ## Documentation Index > Fetch the complete documentation index at: https://docs.tagada.io/llms.txt > Use this file to discover all available pages before exploring further. # Update funnel with routing > Update a funnel configuration and automatically handle plugin mount/unmount/swap operations ## OpenAPI ````yaml /openapi.json put /api/public/v1/funnels/{funnelId} openapi: 3.0.3 info: title: TagadaPay API description: >- # TagadaPay API Documentation Welcome to the TagadaPay API. This REST API lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically. ## Authentication Authenticate every request with a Bearer token. Get your API key from the [TagadaPay Dashboard](https://app.tagada.io). ``` Authorization: Bearer your-api-key ``` All requests must be made over HTTPS with `Content-Type: application/json`. ## Rate Limits | Plan | Requests/min | Burst | |------|-------------|-------| | Standard | 100 | 150 | | Premium | 500 | 750 | Exceeding the limit returns `429 Too Many Requests`. ## Errors | Code | Meaning | |------|---------| | 400 | Bad request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient permissions | | 404 | Not found | | 409 | Conflict | | 429 | Rate limited | | 500 | Server error | ## Support - Email: api-support@tagada.io - Docs: [docs.tagadapay.com](https://docs.tagadapay.com) version: 1.0.0 servers: - url: https://api.tagada.io/ description: Production - url: https://api.tagada.dev/ description: Sandbox / Development security: - bearerAuth: [] tags: - name: auth description: Test your API key and verify authentication. - name: stores description: Create and manage stores within your account. - name: products description: Create products with variants, prices, and currency options. - name: customers description: Manage customer records, addresses, and payment instruments. - name: orders description: List and retrieve orders with line items, payments, and metadata. - name: payments description: Process, list, refund, void, and dispute payments. - name: subscriptions description: >- Create and manage recurring subscriptions — billing, cancellation, rebilling, and processor changes. - name: payment-flows description: Configure payment routing strategies with cascading processor fallbacks. - name: payment-instruments description: >- Manage stored payment methods — cards, bank accounts, and tokenized instruments. - name: processors description: List connected payment processors (Stripe, NMI, Checkout.com, etc.). - name: promotions description: Create and manage discount promotions with rules and conditions. - name: promotion-codes description: Generate and manage reusable promotion/coupon codes. - name: block-rules description: >- Configure fraud prevention rules to block transactions by IP, email, card BIN, country, etc. - name: webhooks description: Register webhook endpoints to receive real-time event notifications. - name: events description: Query application events, statistics, and audit logs. - name: domains description: Add, verify, and manage custom domains for your checkout and funnels. - name: funnels description: >- Create and manage checkout funnels with routing, A/B testing, and CDN deployment. - name: funnel-sessions description: Retrieve funnel session data for analytics and debugging. - name: funnel-tracking description: Track funnel step events for conversion analytics. - name: plugins description: Deploy, manage, and configure checkout plugins. - name: plugins-v2 description: >- V2 plugin system — deploy, mount, split-test, fork, promote, and manage plugin instances. - name: checkout description: >- Initialize checkout sessions and process payments through the hosted checkout. - name: 3ds description: >- 3D Secure authentication — create sessions, authenticate, and handle challenges. - name: builder description: Generate and validate builder session tokens for the visual page editor. - name: health description: API health check endpoint. - name: test description: Test and debugging utilities for the event system (sandbox only). paths: /api/public/v1/funnels/{funnelId}: put: tags: - funnels summary: Update funnel with routing description: >- Update a funnel configuration and automatically handle plugin mount/unmount/swap operations operationId: put-api-public-v1-funnels-{funnelId} parameters: - name: funnelId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: storeId: type: string config: type: object properties: id: type: string name: type: string description: type: string version: type: string default: 1.0.0 nodes: type: array items: type: object properties: id: type: string name: type: string kind: type: string enum: - step - action - condition default: step type: type: string isEntry: type: boolean isDefault: type: boolean isConversion: type: boolean position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false index: type: number row: type: number config: type: object properties: pluginId: type: string nullable: true instanceId: type: string nullable: true instanceVersion: type: string nullable: true variant: type: string nullable: true mountPointId: type: string nullable: true routeId: type: string nullable: true pagePath: type: string nullable: true path: type: string nullable: true url: type: string nullable: true stepConfig: type: object properties: payment: type: object properties: paymentFlowId: type: string additionalProperties: false staticResources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string scripts: type: array items: type: object properties: name: type: string enabled: type: boolean content: type: string position: type: string enum: - head-start - head-end - body-start - body-end required: - name - enabled - content additionalProperties: false pixels: type: object additionalProperties: anyOf: - anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false - type: array items: anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false paymentSetupConfig: type: object additionalProperties: type: object properties: enabled: type: boolean type: type: string label: type: string logoUrl: type: string description: type: string method: type: string provider: type: string express: type: boolean paymentFlowId: type: string processorId: type: string integrationId: type: string supportedCountries: type: array items: type: string presentmentCurrencies: type: array items: type: string recurring: type: boolean publishableKey: type: string methods: type: object additionalProperties: type: object properties: enabled: type: boolean required: - enabled additionalProperties: false providers: type: object additionalProperties: type: object properties: enabled: type: boolean label: type: string min: type: number note: type: string required: - enabled additionalProperties: false metadata: type: object additionalProperties: {} settings: type: object additionalProperties: {} order: type: number required: - enabled additionalProperties: false orderBumps: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string required: - mode additionalProperties: false upsellOffers: type: object properties: mode: type: string enum: - inherit - custom enabledUpsellIds: type: array items: type: string required: - mode additionalProperties: false checkoutOffers: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string defaultOfferId: type: string offerSettings: type: object additionalProperties: type: object properties: description: type: string comparePrice: type: integer minimum: 0 additionalProperties: false required: - mode additionalProperties: false shippingRateSettings: type: object properties: hiddenShippingRateIds: type: array items: type: string additionalProperties: false addressSettings: type: object properties: countryAllowlist: type: array items: type: string forcedCountry: type: string additionalProperties: false paymentSettings: type: object properties: methods: type: object additionalProperties: type: object properties: translations: type: object additionalProperties: type: object properties: label: type: string description: type: string promptText: type: string instructions: type: string additionalProperties: false additionalProperties: false translations: type: object additionalProperties: type: object properties: title: type: string description: type: string dividerText: type: string redirectText: type: string processingLabel: type: string cardNumberLabel: type: string expiryLabel: type: string cvcLabel: type: string cardNumberError: type: string expiryError: type: string expiryFutureError: type: string cvcError: type: string additionalProperties: false additionalProperties: false resources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string paymentInitiator: type: string enum: - merchant - customer additionalProperties: false paymentFlowId: type: string metadata: type: object additionalProperties: {} additionalProperties: false variants: type: array items: type: object properties: id: type: string label: type: string percentage: type: number minimum: 0 maximum: 100 regions: type: array items: type: string config: type: object properties: pluginId: type: string nullable: true instanceId: type: string nullable: true instanceVersion: type: string nullable: true variant: type: string nullable: true mountPointId: type: string nullable: true routeId: type: string nullable: true pagePath: type: string nullable: true path: type: string nullable: true url: type: string nullable: true stepConfig: type: object properties: payment: type: object properties: paymentFlowId: type: string additionalProperties: false staticResources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string scripts: type: array items: type: object properties: name: type: string enabled: type: boolean content: type: string position: type: string enum: - head-start - head-end - body-start - body-end required: - name - enabled - content additionalProperties: false pixels: type: object additionalProperties: anyOf: - anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false - type: array items: anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false paymentSetupConfig: type: object additionalProperties: type: object properties: enabled: type: boolean type: type: string label: type: string logoUrl: type: string description: type: string method: type: string provider: type: string express: type: boolean paymentFlowId: type: string processorId: type: string integrationId: type: string supportedCountries: type: array items: type: string presentmentCurrencies: type: array items: type: string recurring: type: boolean publishableKey: type: string methods: type: object additionalProperties: type: object properties: enabled: type: boolean required: - enabled additionalProperties: false providers: type: object additionalProperties: type: object properties: enabled: type: boolean label: type: string min: type: number note: type: string required: - enabled additionalProperties: false metadata: type: object additionalProperties: {} settings: type: object additionalProperties: {} order: type: number required: - enabled additionalProperties: false orderBumps: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string required: - mode additionalProperties: false upsellOffers: type: object properties: mode: type: string enum: - inherit - custom enabledUpsellIds: type: array items: type: string required: - mode additionalProperties: false checkoutOffers: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string defaultOfferId: type: string offerSettings: type: object additionalProperties: type: object properties: description: type: string comparePrice: type: integer minimum: 0 additionalProperties: false required: - mode additionalProperties: false shippingRateSettings: type: object properties: hiddenShippingRateIds: type: array items: type: string additionalProperties: false addressSettings: type: object properties: countryAllowlist: type: array items: type: string forcedCountry: type: string additionalProperties: false paymentSettings: type: object properties: methods: type: object additionalProperties: type: object properties: translations: type: object additionalProperties: type: object properties: label: type: string description: type: string promptText: type: string instructions: type: string additionalProperties: false additionalProperties: false translations: type: object additionalProperties: type: object properties: title: type: string description: type: string dividerText: type: string redirectText: type: string processingLabel: type: string cardNumberLabel: type: string expiryLabel: type: string cvcLabel: type: string cardNumberError: type: string expiryError: type: string expiryFutureError: type: string cvcError: type: string additionalProperties: false additionalProperties: false resources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string paymentInitiator: type: string enum: - merchant - customer additionalProperties: false paymentFlowId: type: string metadata: type: object additionalProperties: {} additionalProperties: false required: - id - label - percentage - config additionalProperties: false splitType: type: string enum: - weighted - geo metadata: type: object additionalProperties: {} required: - id - name - type additionalProperties: false edges: type: array items: type: object properties: id: type: string source: type: string target: type: string label: type: string conditions: type: object properties: when: anyOf: - type: string - type: object additionalProperties: {} priority: type: number bypassTo: type: string additionalProperties: false metadata: type: object additionalProperties: {} required: - id - source - target additionalProperties: false steps: type: array items: type: object properties: id: type: string name: type: string kind: type: string enum: - step - action - condition default: step type: type: string isEntry: type: boolean isDefault: type: boolean isConversion: type: boolean position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false index: type: number row: type: number config: type: object properties: pluginId: type: string nullable: true instanceId: type: string nullable: true instanceVersion: type: string nullable: true variant: type: string nullable: true mountPointId: type: string nullable: true routeId: type: string nullable: true pagePath: type: string nullable: true path: type: string nullable: true url: type: string nullable: true stepConfig: type: object properties: payment: type: object properties: paymentFlowId: type: string additionalProperties: false staticResources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string scripts: type: array items: type: object properties: name: type: string enabled: type: boolean content: type: string position: type: string enum: - head-start - head-end - body-start - body-end required: - name - enabled - content additionalProperties: false pixels: type: object additionalProperties: anyOf: - anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false - type: array items: anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false paymentSetupConfig: type: object additionalProperties: type: object properties: enabled: type: boolean type: type: string label: type: string logoUrl: type: string description: type: string method: type: string provider: type: string express: type: boolean paymentFlowId: type: string processorId: type: string integrationId: type: string supportedCountries: type: array items: type: string presentmentCurrencies: type: array items: type: string recurring: type: boolean publishableKey: type: string methods: type: object additionalProperties: type: object properties: enabled: type: boolean required: - enabled additionalProperties: false providers: type: object additionalProperties: type: object properties: enabled: type: boolean label: type: string min: type: number note: type: string required: - enabled additionalProperties: false metadata: type: object additionalProperties: {} settings: type: object additionalProperties: {} order: type: number required: - enabled additionalProperties: false orderBumps: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string required: - mode additionalProperties: false upsellOffers: type: object properties: mode: type: string enum: - inherit - custom enabledUpsellIds: type: array items: type: string required: - mode additionalProperties: false checkoutOffers: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string defaultOfferId: type: string offerSettings: type: object additionalProperties: type: object properties: description: type: string comparePrice: type: integer minimum: 0 additionalProperties: false required: - mode additionalProperties: false shippingRateSettings: type: object properties: hiddenShippingRateIds: type: array items: type: string additionalProperties: false addressSettings: type: object properties: countryAllowlist: type: array items: type: string forcedCountry: type: string additionalProperties: false paymentSettings: type: object properties: methods: type: object additionalProperties: type: object properties: translations: type: object additionalProperties: type: object properties: label: type: string description: type: string promptText: type: string instructions: type: string additionalProperties: false additionalProperties: false translations: type: object additionalProperties: type: object properties: title: type: string description: type: string dividerText: type: string redirectText: type: string processingLabel: type: string cardNumberLabel: type: string expiryLabel: type: string cvcLabel: type: string cardNumberError: type: string expiryError: type: string expiryFutureError: type: string cvcError: type: string additionalProperties: false additionalProperties: false resources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string paymentInitiator: type: string enum: - merchant - customer additionalProperties: false paymentFlowId: type: string metadata: type: object additionalProperties: {} additionalProperties: false variants: type: array items: type: object properties: id: type: string label: type: string percentage: type: number minimum: 0 maximum: 100 regions: type: array items: type: string config: type: object properties: pluginId: type: string nullable: true instanceId: type: string nullable: true instanceVersion: type: string nullable: true variant: type: string nullable: true mountPointId: type: string nullable: true routeId: type: string nullable: true pagePath: type: string nullable: true path: type: string nullable: true url: type: string nullable: true stepConfig: type: object properties: payment: type: object properties: paymentFlowId: type: string additionalProperties: false staticResources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string scripts: type: array items: type: object properties: name: type: string enabled: type: boolean content: type: string position: type: string enum: - head-start - head-end - body-start - body-end required: - name - enabled - content additionalProperties: false pixels: type: object additionalProperties: anyOf: - anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false - type: array items: anyOf: - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean required: - PageView - InitiateCheckout - Purchase additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean pixelId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean Search: type: boolean AddToWishlist: type: boolean CompleteRegistration: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent - Search - AddToWishlist - CompleteRegistration additionalProperties: false required: - enabled - pixelId - events additionalProperties: false - type: object properties: enabled: type: boolean containerId: type: string minLength: 1 events: type: object properties: PageView: type: boolean InitiateCheckout: type: boolean Purchase: type: boolean AddToCart: type: boolean ViewContent: type: boolean required: - PageView - InitiateCheckout - Purchase - AddToCart - ViewContent additionalProperties: false googleAdsConversionId: type: string googleAdsConversionLabel: type: string required: - enabled - containerId - events additionalProperties: false - type: object properties: enabled: type: boolean accessToken: type: string minLength: 1 pixelId: type: string minLength: 1 publishPurchaseIfNewCustomerOnly: type: boolean required: - enabled - accessToken - pixelId - publishPurchaseIfNewCustomerOnly additionalProperties: false paymentSetupConfig: type: object additionalProperties: type: object properties: enabled: type: boolean type: type: string label: type: string logoUrl: type: string description: type: string method: type: string provider: type: string express: type: boolean paymentFlowId: type: string processorId: type: string integrationId: type: string supportedCountries: type: array items: type: string presentmentCurrencies: type: array items: type: string recurring: type: boolean publishableKey: type: string methods: type: object additionalProperties: type: object properties: enabled: type: boolean required: - enabled additionalProperties: false providers: type: object additionalProperties: type: object properties: enabled: type: boolean label: type: string min: type: number note: type: string required: - enabled additionalProperties: false metadata: type: object additionalProperties: {} settings: type: object additionalProperties: {} order: type: number required: - enabled additionalProperties: false orderBumps: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string required: - mode additionalProperties: false upsellOffers: type: object properties: mode: type: string enum: - inherit - custom enabledUpsellIds: type: array items: type: string required: - mode additionalProperties: false checkoutOffers: type: object properties: mode: type: string enum: - inherit - custom enabledOfferIds: type: array items: type: string defaultOfferId: type: string offerSettings: type: object additionalProperties: type: object properties: description: type: string comparePrice: type: integer minimum: 0 additionalProperties: false required: - mode additionalProperties: false shippingRateSettings: type: object properties: hiddenShippingRateIds: type: array items: type: string additionalProperties: false addressSettings: type: object properties: countryAllowlist: type: array items: type: string forcedCountry: type: string additionalProperties: false paymentSettings: type: object properties: methods: type: object additionalProperties: type: object properties: translations: type: object additionalProperties: type: object properties: label: type: string description: type: string promptText: type: string instructions: type: string additionalProperties: false additionalProperties: false translations: type: object additionalProperties: type: object properties: title: type: string description: type: string dividerText: type: string redirectText: type: string processingLabel: type: string cardNumberLabel: type: string expiryLabel: type: string cvcLabel: type: string cardNumberError: type: string expiryError: type: string expiryFutureError: type: string cvcError: type: string additionalProperties: false additionalProperties: false resources: type: object additionalProperties: anyOf: - type: string - type: array items: type: string paymentInitiator: type: string enum: - merchant - customer additionalProperties: false paymentFlowId: type: string metadata: type: object additionalProperties: {} additionalProperties: false required: - id - label - percentage - config additionalProperties: false splitType: type: string enum: - weighted - geo metadata: type: object additionalProperties: {} required: - id - name - type additionalProperties: false routing: type: object additionalProperties: {} metadata: type: object additionalProperties: {} required: - name additionalProperties: false isDefault: type: boolean active: type: boolean force: type: boolean required: - storeId - config additionalProperties: false examples: updateFunnel: summary: Update funnel value: funnelId: funnelv2_123 storeId: store_123 config: id: my-funnel name: My Updated Funnel version: 1.0.1 steps: [] responses: '200': description: Successful response content: application/json: schema: {} examples: success: summary: Funnel updated value: funnel: id: funnelv2_123 name: My Updated Funnel operations: - type: mount stepId: step_1 status: completed summary: total: 1 mounted: 1 unmounted: 0 swapped: 0 failed: 0 default: $ref: '#/components/responses/error' security: - bearerAuth: [] components: responses: error: description: Error response content: application/json: schema: type: object properties: message: type: string code: type: string issues: type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your API key as: `Bearer your-api-key`' ````