Skip to main content

CreateGroupRegistrationInput

Defines the input for creating a group registration.

input CreateGroupRegistrationInput {
  comment: String
  contactId: ID!
  customFields: [CustomFieldInput!]
  dateTime: DateTime!
  discountCodeId: ID
  eventId: ID!
  overridePaymentSchedule: [CreateOverridePaymentScheduleItemInput!]
  paymentDetails: CreatePaymentDetailsInput!
  paymentScheduleSource: PaymentScheduleSource
  registrationTypeId: ID!
  taxOverrides: [TaxOverrideInput!]
  tickets: PositiveInt!
}

Fields​

CreateGroupRegistrationInput.comment ● String scalar​

The comments for this registration. Optional.

CreateGroupRegistrationInput.contactId ● ID! non-null scalar​

The identifier of the contact the group registration is associated with.

CreateGroupRegistrationInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the group registration. Optional.

CreateGroupRegistrationInput.dateTime ● DateTime! non-null scalar​

The date and time that the group registration occurred.

CreateGroupRegistrationInput.discountCodeId ● ID scalar​

The identifier of the discount code to apply to the group registration. Optional.

CreateGroupRegistrationInput.eventId ● ID! non-null scalar​

The identifier of the event the group registration is associated with.

CreateGroupRegistrationInput.overridePaymentSchedule ● [CreateOverridePaymentScheduleItemInput!] list input​

The list of payment schedule items to override the default payment schedule, required when paymentScheduleSource is set to CUSTOM. Optional.

CreateGroupRegistrationInput.paymentDetails ● CreatePaymentDetailsInput! non-null input​

The payment details for the group registration.

CreateGroupRegistrationInput.paymentScheduleSource ● PaymentScheduleSource enum​

The source of the payment schedule for the registration. Optional.

Will default to USE_DEFAULT if the registration type has usePaymentSchedule set to TRUE otherwise default to NO_PAYMENT_SCHEDULE.

CreateGroupRegistrationInput.registrationTypeId ● ID! non-null scalar​

The identifier of the registration type the group registration is associated with.

CreateGroupRegistrationInput.taxOverrides ● [TaxOverrideInput!] list input​

The collection of taxes for the group registration booking that will override the taxes from setup. Optional.

When set to null, the default taxes for the group registration will be applied. When set to an empty array, no taxes will be applied.

CreateGroupRegistrationInput.tickets ● PositiveInt! non-null scalar​

The number of tickets to register.

Member Of​

createGroupRegistration mutation