updateCustomField( )

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 a custom field.

For custom fields you can update the following fields: name, defaultPrivacy, socialType.

For system fields you can only update the defaultPrivacy field.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Members
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Custom field ID.

fieldUpdateCustomFieldRequired
Returns
Return Type:Promise<CustomField>
Errors
400Invalid Argument

There are 2 errors with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?