updateDataCollectionField( )


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 properties in a data collection's fields array.

Important:

After fields is updated, it only contains the properties included in the Update Data Collection Field request. If the existing fields array has properties with values and those properties aren't included in the updated details, their values are lost.

To update only specific properties in the array without affecting others, use Patch Data Collection Field.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Data Collections
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
dataCollectionIdstringRequired

ID of the data collection to update.


optionsUpdateDataCollectionFieldOptionsRequired
Returns
Return Type:Promise<UpdateDataCollectionFieldResponse>
Errors

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

Did this help?