renameExtendedField( )
Renames an extended field.
The renameExtendedField() function returns a Promise
that resolves when the specified extended field's display name is changed.
Note:
Only visitors with
Manage Contacts permissions
can rename extended fields.
You can override the permissions by setting the suppressAuth option to true.
Method Declaration
Copy
Method Parameters
keystringRequired
Extended field ID.
When accessing contact data, extended field data is available at extendedFields[key]. For example, if the key is "custom.notes", the value can be accessed at extendedFields["custom.notes"].
key is generated when the extended field is created and cannot be modified, even if displayName changes.
displayNamestringRequired
Display name shown in the Contact List.
optionsAuthOptions
Authorization options.
Returns
Return Type:Promise<ExtendedField>
Was this helpful?
Yes
No