CustomField3.md

CustomField3

This is used to denote the custom field data.

Fields

Field	Type	Required	Description	Example
Category	CustomFieldCategory	✔️	This is used to denote the category of a custom field.	Contact
Name	string	✔️	The actual text of the custom field.	What is a your favorite color?
Code	string	✔️	Code to uniquely identify custom field.	FAVORITE_COLOR_CODE
Required	bool	➖	Whether answer to custom field is mandatory or not.	true
Type	CustomFieldType2	✔️	This is used to denote the type of data collected by a custom field. Auto-Increment custom fields are read only.	Open Ended Text - One Line
Details	CustomField3Details	➖	Type-specific details of the custom-field.
HelpText	string	➖	The help text of the custom field.	Enter your favorite color.
DisplayInDataTag	DisplayInDataTag	➖	This option allows you to choose whether to display the custom field in emails. The field name and the value entered by the invitee are used in the My Agenda data tag. You can set the custom field to display always or only when answered. Only applicable to session custom fields.	No
DefaultTagText	string	➖	Default text in emails when a contact does not have a value answered for this custom field. Only applicable to contact custom fields.	Your Division
ConsentField	bool	➖	True means that this is a consent field. Only applicable to contact custom fields.	false
Active	bool	➖	True means that this custom field is active. Determines visibility for event custom fields.	true
DisplayInEventCreationWizard	bool	➖	True means that the field will be displayed in the event creation wizard. Only applicable to event custom fields.	false
PageVisibility	PageVisibility	➖	Visibility of the custom field on various pages/forms.