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!]!
  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!]!` 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).

`ContactGroup.customFields.input` ● `CustomFieldSearchFilterInput!` non-null input

`ContactGroup.customFields.limit` ● `PaginationLimit!` non-null scalar

`ContactGroup.customFields.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

Fields
Member Of