patchDataCollectionField( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates specified properties in a data collection's fields array.

Only updates the properties specified in the request, all other properties remain unchanged. The following properties can be updated with this method: displayName, type, typeMetadata, encrypted, description. If attempting to update key or other unsupported properties, this operation fails.

To update properties in a data collection other than fields, use Patch Data Collection.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Data Collections
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
dataCollectionIdstringRequired

ID of the data collection to update.

fieldFieldRequired

Field to update.

Returns
Return Type:Promise<PatchDataCollectionFieldResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?