> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateFunctionSpiConfiguration # Package: functions # Namespace: FunctionSpiConfigurations # Method link: https://dev.wix.com/docs/api-reference/business-management/functions/function-spi-configurations/update-function-spi-configuration.md ## Permission Scopes: Manage Functions: SCOPE.DC-FUNCTIONS.MANAGE-FUNCTIONS ## Introduction Updates a service plugin configuration. Each time the service plugin configuration is updated, its `revision` increases by 1. The current `revision` must be passed when updating the service plugin configuration. This ensures you're working with the latest service plugin configuration and prevents unintended overwrites. --- ## REST API ### Schema ``` Method: updateFunctionSpiConfiguration Description: Updates a service plugin configuration. Each time the service plugin configuration is updated, its `revision` increases by 1. The current `revision` must be passed when updating the service plugin configuration. This ensures you're working with the latest service plugin configuration and prevents unintended overwrites. URL: https://www.wixapis.com/functions/v1/function-spi-configurations/{functionSpiConfiguration.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: functionSpiConfiguration, functionSpiConfiguration.id, functionSpiConfiguration.revision Method parameters: param name: functionSpiConfiguration | type: FunctionSpiConfiguration | description: A function SPI configuration is the service plugin configuration for a specific function. | required: true - name: id | type: string | description: Service plugin configuration GUID. | required: true - name: revision | type: string | description: Service plugin configuration revision. | required: true - name: functionId | type: string | description: GUID of the function this service plugin configuration belongs to. - name: configuration | type: object | description: Service plugin configuration data. This must adhere to the schema defined by the function type that the function is based on. Learn more about [service plugins and Wix Functions](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md). Return type: UpdateFunctionSpiConfigurationResponse - name: functionSpiConfiguration | type: FunctionSpiConfiguration | description: Updated service plugin configuration. - name: id | type: string | description: Service plugin configuration GUID. - name: revision | type: string | description: Service plugin configuration revision. - name: createdDate | type: string | description: Date and time the service plugin configuration was created. - name: updatedDate | type: string | description: Date and time the service plugin configuration was last updated. - name: functionId | type: string | description: GUID of the function this service plugin configuration belongs to. - name: configuration | type: object | description: Service plugin configuration data. This must adhere to the schema defined by the function type that the function is based on. Learn more about [service plugins and Wix Functions](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md). ``` ### Examples ### Update Function Spi Configuration ```curl curl --request PATCH \ https://www.wixapis.com/functions/v1/spi-configurations/00019845-6387-4006-9e9b-366caffed188 \ --header "Content-Type: application/json" \ --header "Authorization: " \ --data '{ "functionSpiConfiguration": { "configuration": { "rewardDescription": "Updated Loyalty Program Reward Description", "rewardName": "Frequent buyer perk" }, "id": "00019845-6387-4006-9e9b-366caffed188", "revision": "1" }, "fieldMask": { "paths": [ "configuration" ] } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.functions.FunctionSpiConfigurations.updateFunctionSpiConfiguration(_id, functionSpiConfiguration) Description: Updates a service plugin configuration. Each time the service plugin configuration is updated, its `revision` increases by 1. The current `revision` must be passed when updating the service plugin configuration. This ensures you're working with the latest service plugin configuration and prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: functionSpiConfiguration, _id, functionSpiConfiguration.revision Method parameters: param name: _id | type: string | description: Service plugin configuration GUID. | required: true param name: functionSpiConfiguration | type: UpdateFunctionSpiConfiguration | description: A function SPI configuration is the service plugin configuration for a specific function. | required: true - name: revision | type: string | description: Service plugin configuration revision. | required: true - name: functionId | type: string | description: GUID of the function this service plugin configuration belongs to. - name: configuration | type: object | description: Service plugin configuration data. This must adhere to the schema defined by the function type that the function is based on. Learn more about [service plugins and Wix Functions](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md). Return type: PROMISE - name: _id | type: string | description: Service plugin configuration GUID. - name: revision | type: string | description: Service plugin configuration revision. - name: _createdDate | type: Date | description: Date and time the service plugin configuration was created. - name: _updatedDate | type: Date | description: Date and time the service plugin configuration was last updated. - name: functionId | type: string | description: GUID of the function this service plugin configuration belongs to. - name: configuration | type: object | description: Service plugin configuration data. This must adhere to the schema defined by the function type that the function is based on. Learn more about [service plugins and Wix Functions](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md). ``` ### Examples ### updateFunctionSpiConfiguration ```javascript import { functionSpiConfigurations } from '@wix/functions'; async function updateFunctionSpiConfiguration(_id,functionSpiConfiguration) { const response = await functionSpiConfigurations.updateFunctionSpiConfiguration(_id,functionSpiConfiguration); }; ``` ### updateFunctionSpiConfiguration (with elevated permissions) ```javascript import { functionSpiConfigurations } from '@wix/functions'; import { auth } from '@wix/essentials'; async function myUpdateFunctionSpiConfigurationMethod(_id,functionSpiConfiguration) { const elevatedUpdateFunctionSpiConfiguration = auth.elevate(functionSpiConfigurations.updateFunctionSpiConfiguration); const response = await elevatedUpdateFunctionSpiConfiguration(_id,functionSpiConfiguration); } ``` ### updateFunctionSpiConfiguration (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { functionSpiConfigurations } from '@wix/functions'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { functionSpiConfigurations }, // Include the auth strategy and host as relevant }); async function updateFunctionSpiConfiguration(_id,functionSpiConfiguration) { const response = await myWixClient.functionSpiConfigurations.updateFunctionSpiConfiguration(_id,functionSpiConfiguration); }; ``` ---