getExtendedField( )
Retrieves an extended field.
Description
The getExtendedField()
function returns a Promise
that resolves when the extended field is retrieved.
Note: Only visitors with Manage Contacts permissions can retrieve extended fields. You can override the permissions by setting the
suppressAuth
option totrue
.
Syntax
function getExtendedField(key: string, [options: AuthOptions]): Promise<ExtendedField>
getExtendedField Parameters
NAME
TYPE
DESCRIPTION
Extended field ID .
When accessing contact data,
extended field values are available at extendedFields[key]
.
For example, if the key is "custom.notes",
the value can be accessed at extendedfields["custom.notes"]
.
Once set, key
cannot be modified, even if displayName
changes.
Authorization options.
Returns
Fulfilled - The specified field.
Return Type:
NAME
TYPE
DESCRIPTION
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.
Extended field display name shown in the Contact List.
Type of data the field holds.
One of:
"TEXT"
: Accepts strings."URL"
: Accepts web addresses. Prependshttps://
if no protocol is included."DATE"
: Accepts dates formatted as"YYYY-MM-DD"
."NUMBER"
: Accepts floats.
Indicates whether the extended field is a system field or custom field.
One of:
"SYSTEM"
: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors."USER_DEFINED"
: The field is a custom field and can be modified by 3rd-party apps or site contributors.
Date and time the field was created.
Date and time the field was last updated.
Extended field namespace.
Extended fields created by site contributors or 3rd-party apps
are automatically assigned to the custom
namespace.
Field description, if the field is a system field.
Was this helpful?
Get an extended field
1import { Permissions, webMethod } from 'wix-web-module';2import { contacts } from 'wix-crm-backend';34export const myGetExtendedFieldFunction = webMethod(Permissions.Anyone, () => {5 const fieldKey = "custom.event-name";6 const options = {7 suppressAuth: false8 };910 return contacts.getExtendedField(fieldKey, options)11 .then((extendedField) => {12 return extendedField;13 })14 .catch((error) => {15 console.error(error);16 });17});1819/*20 * Promise resolves to:21 *22 * {23 * "_createdDate": "2021-01-19T21:41:39Z",24 * "_updatedDate": "2021-01-19T21:41:39Z"25 * "namespace": "custom",26 * "key": "custom.event-name",27 * "displayName": "Event Name",28 * "dataType": "TEXT",29 * "fieldType": "USER_DEFINED",30 * }31 */