deleteExtendedField( )


Deletes an extended field.

When an extended field is deleted, any contact data stored in the field is also permanently deleted.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Learn more about app permissions.
Method Declaration
Copy
function deleteExtendedField(key: string): Promise<void>;
Method Parameters
keystringRequired

Extended field key.

JavaScript
import { extendedFields } from "wix-crm.v2"; /* Sample key value: 'custom.nickname' */ export async function myDeleteExtendedFieldFunction(key) { try { const extendedField = await extendedFields.deleteExtendedField(key); console.log("Extended field deleted."); return extendedField; } catch (error) { console.log(error); // Handle the error } } /* Promise resolves to void */
Errors

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

Did this help?