Skip to main content

CeContactStoreContact

Encapsulates information about a contact in EventsAir.

type CeContactStoreContact {
  associatedEventContacts(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [Contact!]!
  billing: BillingContact
  biography: String
  contactPhoneNumbers: ContactPhoneNumbers
  courseRegistrations(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CeContactStoreCourseRegistration!]!
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  department: String
  externalIdentifier: String
  firstName: String
  group: CeContactStoreContactGroup
  id: ID!
  inactiveSince: DateTime
  internalNumber: PositiveInt!
  isAnonymized: Boolean!
  jobTitle: String
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  lastName: String
  marketingPrivacy: ContactMarketingPrivacyStatus!
  marketingRecords(
    input: MarketingSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CeContactStoreMarketingRecord!]!
  middleName: String
  notes(
    input: NoteSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CeContactStoreNote!]!
  onlineUser: OnlineUser!
  organizationName: String
  photo: Image
  preferredName: ContactPreferredName
  primaryAddress: ContactAddress
  primaryEmail: EmailAddress
  secondaryAddress: ContactAddress
  socialMedia: ContactSocialMedia
  suffix: String
  taxNumber: String
  title: String
  useSecondaryAddress: Boolean!
  userDefinedField1: String
  userDefinedField2: String
  userDefinedField3: String
  userDefinedField4: String
  website: String
  workPhone: String
}

Fields​

CeContactStoreContact.associatedEventContacts ● [Contact!]! non-null object​

A list of event contacts associated with this contact store contact. Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
CeContactStoreContact.associatedEventContacts.limit ● PaginationLimit! non-null scalar​
CeContactStoreContact.associatedEventContacts.offset ● NonNegativeInt! non-null scalar​

CeContactStoreContact.billing ● BillingContact object​

The billing details of the contact. Optional.

CeContactStoreContact.biography ● String scalar​

UTF-8 string value that represents the biography of the contact. Optional.

CeContactStoreContact.contactPhoneNumbers ● ContactPhoneNumbers object​

The contact's phone numbers. Optional.

CeContactStoreContact.courseRegistrations ● [CeContactStoreCourseRegistration!]! non-null object​

The course registrations for this contact.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
CeContactStoreContact.courseRegistrations.limit ● PaginationLimit! non-null scalar​
CeContactStoreContact.courseRegistrations.offset ● NonNegativeInt! non-null scalar​

CeContactStoreContact.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

CeContactStoreContact.createdBy ● String scalar​

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

CeContactStoreContact.customFields ● [CustomField!]! non-null object​

A list of custom field values associated with this contact.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
CeContactStoreContact.customFields.input ● CustomFieldSearchFilterInput! non-null input​
CeContactStoreContact.customFields.limit ● PaginationLimit! non-null scalar​
CeContactStoreContact.customFields.offset ● NonNegativeInt! non-null scalar​

CeContactStoreContact.department ● String scalar​

UTF-8 string value that represents the department of the contact. Optional.

CeContactStoreContact.externalIdentifier ● String scalar​

UTF-8 string value that represents the external identifier of the contact. Optional.

CeContactStoreContact.firstName ● String scalar​

UTF-8 string value that represents the first name of the contact. Optional.

CeContactStoreContact.group ● CeContactStoreContactGroup object​

The group that the contact belongs to. Optional.

CeContactStoreContact.id ● ID! non-null scalar​

The unique identifier for the contact.

CeContactStoreContact.inactiveSince ● DateTime scalar​

The date and time since a contact has been inactive. Optional.

A null value means the contact is not inactive.

CeContactStoreContact.internalNumber ● PositiveInt! non-null scalar​

An contact store scoped human readable ID number for a contact that is automatically generated by EventsAir.

CeContactStoreContact.isAnonymized ● Boolean! non-null scalar​

A flag indicating whether the contact is anonymized.

EventsAir's data protection features includes the ability to anonymize personally identifiable information for contacts. When a contact is anonymized, the name, email, and phone number fields are encrypted and can only be read by Data Administrators via the EventsAir user interface. For further information see Removing and anonymizing Contact Records in the EventsAir Education Resources.

CeContactStoreContact.jobTitle ● String scalar​

UTF-8 string value that represents the job title of the contact. Optional.

CeContactStoreContact.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

CeContactStoreContact.lastModifiedBy ● String scalar​

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

CeContactStoreContact.lastName ● String scalar​

UTF-8 string value that represents the last name of the contact. Optional, unless neither primaryEmail or organizationName are specified.

CeContactStoreContact.marketingPrivacy ● ContactMarketingPrivacyStatus! non-null enum​

Represents the preference of the contact with regards to marketing material.

CeContactStoreContact.marketingRecords ● [CeContactStoreMarketingRecord!]! non-null object​

The marketing records for this contact.

See MarketingSearchFilterInput for details on how the optional input argument can be used to filter marketing records.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
CeContactStoreContact.marketingRecords.input ● MarketingSearchFilterInput! non-null input​
CeContactStoreContact.marketingRecords.limit ● PaginationLimit! non-null scalar​
CeContactStoreContact.marketingRecords.offset ● NonNegativeInt! non-null scalar​

CeContactStoreContact.middleName ● String scalar​

UTF-8 string value that represents the middle name of the contact. Optional.

CeContactStoreContact.notes ● [CeContactStoreNote!]! non-null object​

The notes for this contact.

See NoteSearchFilterInput for details on how the optional input argument can be used to filter notes.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
CeContactStoreContact.notes.input ● NoteSearchFilterInput! non-null input​
CeContactStoreContact.notes.limit ● PaginationLimit! non-null scalar​
CeContactStoreContact.notes.offset ● NonNegativeInt! non-null scalar​

CeContactStoreContact.onlineUser ● OnlineUser! non-null object​

The online user details for the contact.

CeContactStoreContact.organizationName ● String scalar​

UTF-8 string value that represents the organization name of the contact. Optional, unless neither lastName or primaryEmail are specified.

CeContactStoreContact.photo ● Image object​

The photo for the contact. Optional.

CeContactStoreContact.preferredName ● ContactPreferredName object​

Contact's preferred name details. Optional.

CeContactStoreContact.primaryAddress ● ContactAddress object​

The contact's primary address. Optional.

CeContactStoreContact.primaryEmail ● EmailAddress scalar​

The contact's primary email address. Optional, unless neither lastName or organizationName are specified.

CeContactStoreContact.secondaryAddress ● ContactAddress object​

The contact's secondary address. Optional.

CeContactStoreContact.socialMedia ● ContactSocialMedia object​

The social media details for the contact. Optional.

CeContactStoreContact.suffix ● String scalar​

UTF-8 string value that represents the name suffix for this contact. Optional.

CeContactStoreContact.taxNumber ● String scalar​

UTF-8 string value that represents the tax number for this contact. Optional.

CeContactStoreContact.title ● String scalar​

UTF-8 string value that represents the title of the contact's name such as Dr/Mrs/Mr. Optional.

CeContactStoreContact.useSecondaryAddress ● Boolean! non-null scalar​

A flag indicating that the contact’s secondary address should be used instead of the primary address.

CeContactStoreContact.userDefinedField1 ● String scalar​

UTF-8 string value that represents the user defined field 1 of the contact. Optional.

CeContactStoreContact.userDefinedField2 ● String scalar​

UTF-8 string value that represents the user defined field 2 of the contact. Optional.

CeContactStoreContact.userDefinedField3 ● String scalar​

UTF-8 string value that represents the user defined field 3 of the contact. Optional.

CeContactStoreContact.userDefinedField4 ● String scalar​

UTF-8 string value that represents the user defined field 4 of the contact. Optional.

CeContactStoreContact.website ● String scalar​

UTF-8 string value that represents the website of the contact. Optional.

CeContactStoreContact.workPhone ● String scalar​

UTF-8 string value that represents the contact's work phone number. Optional.

Member Of​

CeContactStore object ● CeContactStoreContactGroup object ● CeContactStoreCourseInstructor object ● CeContactStoreCourseRegistration object ● CeContactStoreMarketingRecord object ● CeContactStoreNote object ● CreateCeContactStoreContactPayload object ● UpdateCeContactStoreContactBillingPayload object ● UpdateCeContactStoreContactDetailsPayload object

Implemented By​

AssociatedContactStoreContact union