Skip to main content

UpdateSponsorshipInput

Defines the input for updating a sponsorship.

input UpdateSponsorshipInput {
  attachedDocuments: [UpdateSponsorshipAttachedDocumentInput!]
  brochures: [UpdateBrochureInput!]
  cancelationTaxOverrides: [TaxOverrideInput!]
  companyLogo: CompanyLogoInput
  contactId: ID!
  customFields: [CustomFieldInput!]
  eventId: ID!
  inclusions: [SponsorshipItemInput!]
  notes: String
  paymentDetails: UpdateSponsorshipPaymentDetailsInput
  profile: String
  quantity: NonNegativeInt
  sponsorshipId: ID!
  sponsorshipPackageId: ID
  taxOverrides: [TaxOverrideInput!]
}

Fields​

UpdateSponsorshipInput.attachedDocuments ● [UpdateSponsorshipAttachedDocumentInput!] list input​

The list of attached documents to create/update against the sponsorship. Optional.

Rules

  • Omitting the input value will keep the existing attached documents as-is.
  • Passing an empty list will remove all of the attached documents from the sponsorship.
  • If passing a list with attached documents, for any existing attached documents where the documentTypeId is not provided the attached document will be removed.
  • Attached Documents where the documentTypeId is specified will be updated or created.

UpdateSponsorshipInput.brochures ● [UpdateBrochureInput!] list input​

The list of brochures to create/update against the sponsorship. Optional.

Rules

  • Omitting the input value will keep the existing brochures as-is.
  • Passing null or an empty list will remove all brochures from the sponsorship.
  • If passing a list of brochures, omitted existing brochures will be removed from the sponsorship.
  • Brochures where the id is specified will be updated, otherwise they will be created.

UpdateSponsorshipInput.cancelationTaxOverrides ● [TaxOverrideInput!] list input​

The collection of cancelation taxes for the sponsorship booking that will override the cancelation taxes from setup. Optional.

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

UpdateSponsorshipInput.companyLogo ● CompanyLogoInput input​

The company logo for the sponsorship. Optional.

UpdateSponsorshipInput.contactId ● ID! non-null scalar​

The identifier of the contact for the sponsorship.

UpdateSponsorshipInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the sponsorship. Optional.

UpdateSponsorshipInput.eventId ● ID! non-null scalar​

The identifier of the event the sponsorship is associated with.

UpdateSponsorshipInput.inclusions ● [SponsorshipItemInput!] list input​

The list of inclusions to create/update against the sponsorship. Optional.

Rules

  • Omitting the input value will keep the existing inclusions as-is.
  • Passing null or an empty list will reset the inclusions to the sponsorship package inclusions.
  • If passing a list with inclusions, for any existing inclusion where the inclusionId is not provided the item will be removed.
  • Inclusions where the inclusionId is specified will be updated or created.

UpdateSponsorshipInput.notes ● String scalar​

A UTF-8 string that represents the notes for the sponsorship. Optional.

UpdateSponsorshipInput.paymentDetails ● UpdateSponsorshipPaymentDetailsInput input​

The payment details for the sponsorship. Optional.

UpdateSponsorshipInput.profile ● String scalar​

A UTF-8 string that represents the profile for the sponsorship. Optional.

UpdateSponsorshipInput.quantity ● NonNegativeInt scalar​

The number of packages for the sponsorship. Optional.

UpdateSponsorshipInput.sponsorshipId ● ID! non-null scalar​

The identifier of the sponsorship.

UpdateSponsorshipInput.sponsorshipPackageId ● ID scalar​

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

UpdateSponsorshipInput.taxOverrides ● [TaxOverrideInput!] list input​

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

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

Member Of​

updateSponsorship mutation