Skip to main content

ContactGroup

Defines a type for a contact group. This type is used to represent a group of contacts in an event.

type ContactGroup {
  coordinator: Contact!
  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!
  members(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [Contact!]!
  name: String!
}

Fields​

ContactGroup.coordinator ● Contact! non-null object​

The coordinator of the contact group.

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

ContactGroup.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.
ContactGroup.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
ContactGroup.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
ContactGroup.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

ContactGroup.members ● [Contact!]! non-null object​

The members of the contact group.

ContactGroup.members.limit ● PaginationLimit! non-null scalar​
ContactGroup.members.offset ● NonNegativeInt! non-null scalar​

ContactGroup.name ● String! non-null scalar​

The name of the contact group.

Member Of​

Contact object ● CreateEventContactGroupPayload object ● Event object ● LinkContactToEventContactGroupPayload object ● UpdateEventContactGroupCustomFieldsPayload object ● UpdateEventContactGroupNamePayload object