Skip to main content

CreateSponsorshipPackageInput

Defines the input for creating a sponsorship package.

input CreateSponsorshipPackageInput {
  additionalPaymentStatuses: [AdditionalPaymentStatus!]
  alternateCurrencyFees: [AlternateCurrencyFeeInput!]
  backgroundColor: HexColorCode
  defaultFee: FeeInput
  eventId: ID!
  eventPackageId: ID
  inclusions: [SponsorshipPackageItemInput!]
  incomeAccountId: ID
  inventoryLimit: NonNegativeInt
  name: String!
  rank: NonNegativeInt
  rankHeading: String
  showBoldText: Boolean
  textColor: HexColorCode
  uniqueCode: String
}

Fields​

CreateSponsorshipPackageInput.additionalPaymentStatuses ● [AdditionalPaymentStatus!] list enum​

The additional valid payment statuses for this sponsorship package. Optional.

CreateSponsorshipPackageInput.alternateCurrencyFees ● [AlternateCurrencyFeeInput!] list input​

The collection of fees in alternate currencies. Optional.

CreateSponsorshipPackageInput.backgroundColor ● HexColorCode scalar​

The hex color code to use for the background when rendering the sponsors of this sponsorship package in a sponsor listing. Optional.

The default value is #3987AD.

CreateSponsorshipPackageInput.defaultFee ● FeeInput input​

The fee charged for this sponsorship package in the event currency. Optional.

Will default to 0.

CreateSponsorshipPackageInput.eventId ● ID! non-null scalar​

The identifier of the event the sponsorship package is associated with.

CreateSponsorshipPackageInput.eventPackageId ● ID scalar​

The identifier of the event package to automatically allocate with bookings of this sponsorship package. Optional.

CreateSponsorshipPackageInput.inclusions ● [SponsorshipPackageItemInput!] list input​

A collection of inclusions to include in the sponsorship package. Optional.

CreateSponsorshipPackageInput.incomeAccountId ● ID scalar​

The identifier of the income account for the sponsorship package. Optional.

The value will default to the ID of the first income account in account number order.

CreateSponsorshipPackageInput.inventoryLimit ● NonNegativeInt scalar​

The inventory limit for this sponsorship package. Optional.

If not specified the inventory will be unlimited.

CreateSponsorshipPackageInput.name ● String! non-null scalar​

A UTF-8 string representing the name of the sponsorship package.

CreateSponsorshipPackageInput.rank ● NonNegativeInt scalar​

A number indicating the rank order that this sponsorship package belongs to. Optional.

The default value is 0.

CreateSponsorshipPackageInput.rankHeading ● String scalar​

A UTF-8 string representing the rank heading to display for this sponsorship package. Optional.

CreateSponsorshipPackageInput.showBoldText ● Boolean scalar​

A flag indicating whether the text should be bold when rendering the sponsors of this sponsorship package in the sponsor listing. Optional.

The default value is false.

CreateSponsorshipPackageInput.textColor ● HexColorCode scalar​

The hex color code to use when rendering the text for the sponsors of this sponsorship package in the sponsor listing. Optional.

The default value is #FFFFFF.

CreateSponsorshipPackageInput.uniqueCode ● String scalar​

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

The value must be unique across all sponsorship packages for an event.

Member Of​

createSponsorshipPackage mutation