getExtendedField( )
Retrieves an extended field.
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 to true.
Method Declaration
Copy
Method Parameters
keystringRequired
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.
optionsAuthOptions
Authorization options.
Returns
Return Type:Promise<ExtendedField>
Was this helpful?
Yes
No