Skip to main content

ContactStore

Represents an EventsAir contact store.

type ContactStore {
  accessRights: AccessRights!
  alias: String!
  associatedEvents(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [Event!]!
  communicationTags(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CommunicationTag!]!
  contact(
    id: ID!
  ): ContactStoreContact!
  contacts(
    input: ContactStoreContactSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreContact!]!
  country: String
  createdAt: DateTime!
  createdBy: String
  currencies: [Currency!]!
  customFieldDefinitions: ContactStoreScopedCustomFieldDefinitions!
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  defaultCurrency: Currency!
  emailMessagingService: EmailMessagingService
  id: ID!
  invoiceConfiguration: InvoiceConfiguration
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  link(
    id: ID!
  ): Link!
  links: [Link!]!
  logo: Image
  marketingRecords(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreMarketingRecord!]!
  mergeDocuments(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [MergeDocument!]!
  name: String!
  notes(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreNote!]!
  office: Office!
  onlinePaymentServices: OnlinePaymentServices!
  setup: ContactStoreSetup!
  state: String
  textMessagingService: TextMessagingService
  uniqueCode: String
  userAccessRights: UserAccessRights! @deprecated
}

Fields​

ContactStore.accessRights ● AccessRights! non-null object​

Indicates which users or API keys in EventsAir can access this contact store.

ContactStore.alias ● String! non-null scalar​

A UTF-8 alphanumeric string representing an alias for a contact store. The alias is used as part of the URL for websites.

An alias can only contain lower-case, alphameric and hyphen characters: [a-z0-9-].

ContactStore.associatedEvents ● [Event!]! non-null object​

A list of events associated with this contact store.

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

ContactStore.communicationTags ● [CommunicationTag!]! non-null object​

A list of communication tags for this contact store.

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

ContactStore.contact ● ContactStoreContact! non-null object​

Retrieves a contact by its identifier. Throws an error with code NOT_FOUND if no contact is found.

ContactStore.contact.id ● ID! non-null scalar​

ContactStore.contacts ● [ContactStoreContact!]! non-null object​

Contacts for this contact store that match the filter criteria specified in the optional input argument.

By default, inactive contacts are not returned. To include inactive contacts in the result set, set input.contactFilter.includeInactive to true.

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

Note: the offset argument must be a multiple of the limit argument otherwise an error will be thrown. The following table shows examples of valid and invalid argument value combinations.

limitoffsetIs valid?
1000✅ Yes
100100✅ Yes
100120❌ No
50100✅ Yes
5075❌ No
250750✅ Yes
3399✅ Yes
33100❌ No

Throws an error with code:

  • BAD_USER_INPUT if the offset argument is not a multiple of the limit argument
  • BAD_USER_INPUT if all fields in the input have a combined total number of values exceeding 1,000
ContactStore.contacts.input ● ContactStoreContactSearchFilterInput! non-null input​
ContactStore.contacts.limit ● PaginationLimit! non-null scalar​
ContactStore.contacts.offset ● NonNegativeInt! non-null scalar​

ContactStore.country ● String scalar​

The name of the country for the contact store. For example The United States of America. Optional.

ContactStore.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

ContactStore.createdBy ● String scalar​

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

ContactStore.currencies ● [Currency!]! non-null object​

A list of supported currencies for the contact store.

ContactStore.customFieldDefinitions ● ContactStoreScopedCustomFieldDefinitions! non-null object​

A list of custom field definitions associated with this contact store. The provided key identifies which type of object the fields relate too.

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

A list of custom field values associated with this contact store.

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

ContactStore.defaultCurrency ● Currency! non-null object​

A default currency for the contact store.

ContactStore.emailMessagingService ● EmailMessagingService object​

The external connected service integrated with this contact store for email messaging. Optional.

ContactStore.id ● ID! non-null scalar​

The unique identifier for a contact store.

ContactStore.invoiceConfiguration ● InvoiceConfiguration object​

Specifies the configuration of invoices for this contact store. Optional.

ContactStore.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

ContactStore.lastModifiedBy ● String scalar​

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

ContactStore.link ● Link! non-null object​

Retrieves a link by its identifier. Throws an error with code NOT_FOUND if no link is found.

ContactStore.link.id ● ID! non-null scalar​

ContactStore.links ● [Link!]! non-null object​

The list of links for this contact store.

ContactStore.logo ● Image object​

The logo for the contact store. Optional.

ContactStore.marketingRecords ● [ContactStoreMarketingRecord!]! non-null object​

The marketing records for this contact store.

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

ContactStore.mergeDocuments ● [MergeDocument!]! non-null object​

A list of Merge Documents for this contact store.

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

ContactStore.name ● String! non-null scalar​

A UTF-8 string representing the name of a contact store.

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

The notes for this contact store.

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

ContactStore.office ● Office! non-null object​

The office that manages the contact store.

ContactStore.onlinePaymentServices ● OnlinePaymentServices! non-null object​

The external connected services integrated with this contact store for online payment processing.

ContactStore.setup ● ContactStoreSetup! non-null object​

The setup for the contact store.

ContactStore.state ● String scalar​

The state, territory or province for the contact store. For example New York. Optional.

ContactStore.textMessagingService ● TextMessagingService object​

The external connected service integrated with this contact store for text messaging. Optional.

ContactStore.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the contact store. Optional.

The value must be unique across all contact stores and events for a tenant.

ContactStore.userAccessRights ● UserAccessRights! deprecated non-null object​

DEPRECATED

Use accessRights instead. This field will be removed in a future release.

Indicates which users in EventsAir can access this contact store.

Returned By​

contactStore query ● contactStores query

Member Of​

UpdateContactStorePayload object

Implemented By​

ContactDataStore union