Skip to main content

ContactStoreCustomFieldDefinition

The definition for a custom field associated with an EventsAir entity within a contact store. Custom fields can be used to collect additional information beyond what is captured as standard in EventsAir.

type ContactStoreCustomFieldDefinition implements CustomFieldDefinition {
  containsPersonalData: Boolean!
  createdAt: DateTime!
  createdBy: String
  id: ID!
  isMandatory: Boolean!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  sortOrder: Int!
  tags(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomFieldDefinitionTag!]
  type: CustomFieldType!
  uniqueCode: String
}

Fields​

ContactStoreCustomFieldDefinition.containsPersonalData ● Boolean! non-null scalar​

A flag indicating whether the custom field includes sensitive personal data. It is important for event managers to review any additional fields that they have created and marking those fields as containing personal data. This is used by EventsAir to identify these fields for reporting to attendees, and when anonymizing or deleting a contact record for data privacy reasons.

ContactStoreCustomFieldDefinition.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

ContactStoreCustomFieldDefinition.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

ContactStoreCustomFieldDefinition.id ● ID! non-null scalar​

The unique identifier for a custom field definition.

ContactStoreCustomFieldDefinition.isMandatory ● Boolean! non-null scalar​

A flag indicating whether the custom field requires a value to be completed.

ContactStoreCustomFieldDefinition.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

ContactStoreCustomFieldDefinition.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

ContactStoreCustomFieldDefinition.name ● String! non-null scalar​

The name of the custom field definition.

ContactStoreCustomFieldDefinition.sortOrder ● Int! non-null scalar​

Defines the order that the custom fields are sorted by in lists. Items are sorted in ascending order (smallest to largest).

ContactStoreCustomFieldDefinition.tags ● [CustomFieldDefinitionTag!] list object​

The values of the tag custom field. Optional.

For custom field definitions where type is TAG, it will contain the values that can be assigned to the custom field for this definition. For other custom field definitions, it will be null.

ContactStoreCustomFieldDefinition.tags.limit ● PaginationLimit! non-null scalar​
ContactStoreCustomFieldDefinition.tags.offset ● NonNegativeInt! non-null scalar​

ContactStoreCustomFieldDefinition.type ● CustomFieldType! non-null enum​

Represents the type for the custom field.

ContactStoreCustomFieldDefinition.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the custom field definition. Optional.

The value must be unique across all custom field definitions within the scope that it is defined:

  • For Event, Office, Supplier and User custom field definitions, the value must be unique across all custom field definitions for a tenant.
  • For custom field definitions defined for a contact store module, the value must be unique across all custom field definitions for that module.

Interfaces​

CustomFieldDefinition interface​

The definition for a custom field associated with an EventsAir entity. Custom fields can be used to collect additional information beyond what is captured as standard in EventsAir.