Skip to main content

ContactStoreContact

Encapsulates information about a contact in EventsAir.

type ContactStoreContact {
additionalEmails: [String!]!
associatedEventContacts(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Contact!]!
billing: BillingContact
biography: String
communications(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [SentCommunication!]!
contactPhoneNumbers: ContactPhoneNumbers
createdAt: DateTime!
createdBy: String
customFields(
input: CustomFieldSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [CustomField!]! @deprecated
customFieldsPaged(
filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): CustomFieldPage!
department: String
dietary: Dietary
externalIdentifier: String
firstName: String
id: ID!
inactiveSince: DateTime
incompleteRegistrationDate: DateTime
incompleteRegistrationSite: Link
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
): [ContactStoreMarketingRecord!]!
middleName: String
notes(
input: NoteSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [ContactStoreNote!]! @deprecated
notesPaged(
filterInput: NoteAdvancedSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): ContactStoreNotePage!
onlineUser: OnlineUser!
organizationName: String
photo: Image
preferredName: ContactPreferredName
primaryAddress: ContactAddress
primaryEmail: EmailAddress
secondaryAddress: ContactAddress
socialMedia: ContactSocialMedia
subDepartment: String
suffix: String
taxNumber: String
title: String
trackingCodeIncomplete: String
trackingCodeSubmitted: String
useSecondaryAddress: Boolean!
userDefinedField1: String
userDefinedField2: String
userDefinedField3: String
userDefinedField4: String
website: String
workPhone: String
}

Fields​

ContactStoreContact.additionalEmails ● [String!]! non-null scalar​

The contact's additional email addresses.

ContactStoreContact.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).
ContactStoreContact.associatedEventContacts.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.associatedEventContacts.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.billing ● BillingContact object​

The billing details of the contact. Optional.

ContactStoreContact.biography ● String scalar​

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

ContactStoreContact.communications ● [SentCommunication!]! non-null object​

The communications that have been sent to 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).
ContactStoreContact.communications.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.communications.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.contactPhoneNumbers ● ContactPhoneNumbers object​

The contact's phone numbers. Optional.

ContactStoreContact.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

ContactStoreContact.createdBy ● String scalar​

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

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

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

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).
ContactStoreContact.customFields.input ● CustomFieldSearchFilterInput! non-null input​
ContactStoreContact.customFields.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.customFields.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.customFieldsPaged ● CustomFieldPage! non-null object​

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

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).

Throws an error with code:

  • BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.
ContactStoreContact.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
ContactStoreContact.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.department ● String scalar​

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

ContactStoreContact.dietary ● Dietary object​

The dietary information for this contact. Optional.

ContactStoreContact.externalIdentifier ● String scalar​

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

ContactStoreContact.firstName ● String scalar​

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

ContactStoreContact.id ● ID! non-null scalar​

The unique identifier for the contact.

ContactStoreContact.inactiveSince ● DateTime scalar​

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

A null value means the contact is not inactive.

ContactStoreContact.incompleteRegistrationDate ● DateTime scalar​

The date and time the contact was captured as an incomplete registration. Optional.

A null value means the contact has not been captured as an incomplete registration.

ContactStoreContact.incompleteRegistrationSite ● Link object​

The link for the interactive site that the incomplete registration was captured on. Optional.

ContactStoreContact.internalNumber ● PositiveInt! non-null scalar​

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

ContactStoreContact.isAnonymized ● Boolean! non-null scalar​

A flag indicating whether the contact is anonymized.

ContactStoreContact.jobTitle ● String scalar​

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

ContactStoreContact.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

ContactStoreContact.lastModifiedBy ● String scalar​

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

ContactStoreContact.lastName ● String scalar​

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

ContactStoreContact.marketingPrivacy ● ContactMarketingPrivacyStatus! non-null enum​

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

ContactStoreContact.marketingRecords ● [ContactStoreMarketingRecord!]! 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).
ContactStoreContact.marketingRecords.input ● MarketingSearchFilterInput! non-null input​
ContactStoreContact.marketingRecords.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.marketingRecords.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.middleName ● String scalar​

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

ContactStoreContact.notes ● [ContactStoreNote!]! deprecated non-null object​

DEPRECATED

Use notesPaged instead. It returns the same notes together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

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).
ContactStoreContact.notes.input ● NoteSearchFilterInput! non-null input​
ContactStoreContact.notes.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.notes.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.notesPaged ● ContactStoreNotePage! non-null object​

Notes for this contact that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

Returns a ContactStoreNotePage wrapper exposing the matched items alongside pageInfo (total count, has-next-page, has-previous-page).

See NoteAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn) — for example, "all notes whose id is not in a specific list."

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).

Throws an error with code: BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

ContactStoreContact.notesPaged.filterInput ● NoteAdvancedSearchFilterInput! non-null input​
ContactStoreContact.notesPaged.limit ● PaginationLimit! non-null scalar​
ContactStoreContact.notesPaged.offset ● NonNegativeInt! non-null scalar​

ContactStoreContact.onlineUser ● OnlineUser! non-null object​

The online user details for the contact.

ContactStoreContact.organizationName ● String scalar​

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

ContactStoreContact.photo ● Image object​

The photo for the contact. Optional.

ContactStoreContact.preferredName ● ContactPreferredName object​

Contact's preferred name details. Optional.

ContactStoreContact.primaryAddress ● ContactAddress object​

The contact's primary address. Optional.

ContactStoreContact.primaryEmail ● EmailAddress scalar​

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

ContactStoreContact.secondaryAddress ● ContactAddress object​

The contact's secondary address. Optional.

ContactStoreContact.socialMedia ● ContactSocialMedia object​

The social media details for the contact. Optional.

ContactStoreContact.subDepartment ● String scalar​

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

ContactStoreContact.suffix ● String scalar​

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

ContactStoreContact.taxNumber ● String scalar​

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

ContactStoreContact.title ● String scalar​

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

ContactStoreContact.trackingCodeIncomplete ● String scalar​

A UTF-8 string that represents the tracking codes for an incomplete interactive site registration. Optional.

ContactStoreContact.trackingCodeSubmitted ● String scalar​

A UTF-8 string that represents the tracking codes for a submitted interactive site registration. Optional.

ContactStoreContact.useSecondaryAddress ● Boolean! non-null scalar​

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

ContactStoreContact.userDefinedField1 ● String scalar​

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

ContactStoreContact.userDefinedField2 ● String scalar​

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

ContactStoreContact.userDefinedField3 ● String scalar​

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

ContactStoreContact.userDefinedField4 ● String scalar​

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

ContactStoreContact.website ● String scalar​

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

ContactStoreContact.workPhone ● String scalar​

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

Member Of​

ContactStore object ● ContactStoreContactPage object ● ContactStoreMarketingRecord object ● ContactStoreNote object ● CreateContactStoreContactPayload object ● UpdateContactStoreContactBillingPayload object ● UpdateContactStoreContactDetailsPayload object

Implemented By​

AssociatedContactStoreContact union