> 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

# ValidateFunctionSpiConfiguration

# Package: functions

# Namespace: FunctionSpiConfigurations

# Method link: https://dev.wix.com/docs/api-reference/business-management/functions/function-spi-configurations/validate-function-spi-configuration.md

## Permission Scopes:
Manage Functions: SCOPE.DC-FUNCTIONS.MANAGE-FUNCTIONS

## Introduction

Validates a service plugin configuration against the service plugin schema without creating it.

Learn more about [service plugin schema and configurations](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md#service-plugin-schema-and-configurations).

---

## REST API

### Schema

```
 Method: validateFunctionSpiConfiguration
 Description: Validates a service plugin configuration against the service plugin schema without creating it.  Learn more about [service plugin schema and configurations](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md#service-plugin-schema-and-configurations).
 URL: https://www.wixapis.com/functions/v1/function-spi-configurations/validate
 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: ValidateFunctionSpiConfigurationResponse
  - name: valid | type: boolean | description: Whether the service plugin configuration is valid. 
  - name: validationErrors | type: array<FunctionSpiConfigurationError> | description: List of validation errors for the service plugin configuration. 
     - name: errorType | type: ErrorType | description: Type of validation error. 
         - enum:
         -     MISSING_REQUIRED_FIELD: Required field is missing from the configuration.
         -     TYPE_MISMATCH: Field value has incorrect data type.
         -     SCHEMA_MISMATCH: Configuration structure doesn't match the expected schema.


```

### Examples

### Validate Function Spi Configuration
```curl
curl --request POST \
  https://www.wixapis.com/functions/v1/spi-configurations/validate \
  --header "Authorization: <AUTH>" \
  --header "Content-Type: application/json" \
  --data '{
    "functionSpiConfiguration": {
      "functionId": "4e697e0c-bdde-4f02-84ed-1e8cf4ed566e",
      "configuration": {
        "rewardDescription": "Loyalty Program Reward",
        "rewardName": "Frequent buyer perk"
      }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.functions.FunctionSpiConfigurations.validateFunctionSpiConfiguration(functionSpiConfiguration)
 Description: Validates a service plugin configuration against the service plugin schema without creating it.  Learn more about [service plugin schema and configurations](https://dev.wix.com/docs/api-reference/business-management/functions/about-service-plugins-and-wix-functions.md#service-plugin-schema-and-configurations).
 # 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<ValidateFunctionSpiConfigurationResponse>
  - name: valid | type: boolean | description: Whether the service plugin configuration is valid. 
  - name: validationErrors | type: array<FunctionSpiConfigurationError> | description: List of validation errors for the service plugin configuration. 
     - name: errorType | type: ErrorType | description: Type of validation error. 
         - enum:
         -     MISSING_REQUIRED_FIELD: Required field is missing from the configuration.
         -     TYPE_MISMATCH: Field value has incorrect data type.
         -     SCHEMA_MISMATCH: Configuration structure doesn't match the expected schema.


```

### Examples

### validateFunctionSpiConfiguration
```javascript
import { functionSpiConfigurations } from '@wix/functions';

async function validateFunctionSpiConfiguration(functionSpiConfiguration) {
  const response = await functionSpiConfigurations.validateFunctionSpiConfiguration(functionSpiConfiguration);
};
```

### validateFunctionSpiConfiguration (with elevated permissions)
```javascript
import { functionSpiConfigurations } from '@wix/functions';
import { auth } from '@wix/essentials';

async function myValidateFunctionSpiConfigurationMethod(functionSpiConfiguration) {
  const elevatedValidateFunctionSpiConfiguration = auth.elevate(functionSpiConfigurations.validateFunctionSpiConfiguration);
  const response = await elevatedValidateFunctionSpiConfiguration(functionSpiConfiguration);
}
```

### validateFunctionSpiConfiguration (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 validateFunctionSpiConfiguration(functionSpiConfiguration) {
  const response = await myWixClient.functionSpiConfigurations.validateFunctionSpiConfiguration(functionSpiConfiguration);
};
```

---