> 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 # CreateFunctionSpiConfiguration # Package: functions # Namespace: FunctionSpiConfigurations # Method link: https://dev.wix.com/docs/api-reference/business-management/functions/function-spi-configurations/create-function-spi-configuration.md ## Permission Scopes: Manage Functions: SCOPE.DC-FUNCTIONS.MANAGE-FUNCTIONS ## Introduction Creates a service plugin configuration for a function. --- ## REST API ### Schema ``` Method: createFunctionSpiConfiguration Description: Creates a service plugin configuration for a function. URL: https://www.wixapis.com/functions/v1/function-spi-configurations Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: functionSpiConfiguration Method parameters: param name: functionSpiConfiguration | type: FunctionSpiConfiguration | description: A function SPI configuration is the service plugin configuration for a specific function. | 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: CreateFunctionSpiConfigurationResponse - name: functionSpiConfiguration | type: FunctionSpiConfiguration | description: The created 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 ### Create Function Spi Configuration ```curl curl --request POST \ https://www.wixapis.com/functions/v1/spi-configurations \ --header "Authorization: " \ --header "Content-Type: application/json" \ --data '{ "functionSpiConfiguration": { "functionId": "e36c1a6b-d1ad-4077-b841-c36076b029e5", "configuration": { "rewardDescription": "Loyalty Program Reward", "rewardName": "Frequent buyer perk" } } }' ``` ### Create Empty Function Spi Configuration ```curl curl --request POST \ https://www.wixapis.com/functions/v1/spi-configurations \ --header "Authorization: " \ --header "Content-Type: application/json" \ --data '{ "functionSpiConfiguration": { "functionId": "bf65c75e-c0f6-4d38-9b40-691bc3f768e2" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.functions.FunctionSpiConfigurations.createFunctionSpiConfiguration(functionSpiConfiguration) Description: Creates a service plugin configuration for a function. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: functionSpiConfiguration Method parameters: param name: functionSpiConfiguration | type: FunctionSpiConfiguration | description: A function SPI configuration is the service plugin configuration for a specific function. | 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 ### createFunctionSpiConfiguration ```javascript import { functionSpiConfigurations } from '@wix/functions'; async function createFunctionSpiConfiguration(functionSpiConfiguration) { const response = await functionSpiConfigurations.createFunctionSpiConfiguration(functionSpiConfiguration); }; ``` ### createFunctionSpiConfiguration (with elevated permissions) ```javascript import { functionSpiConfigurations } from '@wix/functions'; import { auth } from '@wix/essentials'; async function myCreateFunctionSpiConfigurationMethod(functionSpiConfiguration) { const elevatedCreateFunctionSpiConfiguration = auth.elevate(functionSpiConfigurations.createFunctionSpiConfiguration); const response = await elevatedCreateFunctionSpiConfiguration(functionSpiConfiguration); } ``` ### createFunctionSpiConfiguration (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 createFunctionSpiConfiguration(functionSpiConfiguration) { const response = await myWixClient.functionSpiConfigurations.createFunctionSpiConfiguration(functionSpiConfiguration); }; ``` ---