Skip to main content

GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.
  • Type InitializeAccountInput was removed
  • Type InitializeUserInput was removed
  • Type BaseInitializeAccountInput was added
  • Type BaseInitializeUserInput was added
  • Type for argument input on field Mutation.initializeUser changed from InitializeUserInput! to BaseInitializeUserInput!
  • Type for argument input on field Mutation.initializeAccount changed from InitializeAccountInput! to BaseInitializeAccountInput!
  • Deprecation reason on field GenerateInkPresignedUrl.presignedPostFields changed from The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. to The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-25.
  • Field inkMessageTextContent was added to object type Query
  • Deprecation reason on field ReferralSchemeType.referrerFamilyName changed from The 'referringFamilyName' field is deprecated. Only make use of the referrerGivenName for privacy reasons. - Marked as deprecated on 2022-11-07. - Scheduled for removal on or after 2023-01-07. to The 'referrerFamilyName' field is deprecated. Only make use of the referrerGivenName for privacy reasons. - Marked as deprecated on 2022-11-07. - Scheduled for removal on or after 2023-01-07.
  • Deprecation reason on field GenerateInkPresignedUrl.presignedPostFields changed from The 'presigned_post_fields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12. to The 'presignedPostFields' field is deprecated. This field is deprecated. Please use the 'fields' key instead. - Marked as deprecated on 2024-04-25. - Scheduled for removal on or after 2025-07-12.
  • Deprecation reason on field UpsideDispatchType.deltaKwh changed from The 'delta_kwh' field is deprecated. delta has replaced deltaKwh for increased precision. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'deltaKwh' field is deprecated. delta has replaced deltaKwh for increased precision. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01.
  • Deprecation reason on field UpsideDispatchType.startDt changed from The 'start_dt' field is deprecated. start has replaced start_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'startDt' field is deprecated. start has replaced start_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01.
  • Deprecation reason on field UpsideDispatchType.endDt changed from The 'end_dt' field is deprecated. end has replaced end_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01. to The 'endDt' field is deprecated. end has replaced end_dt for improved typing. - Marked as deprecated on 2024-04-19. - Scheduled for removal on or after 2025-01-01.
  • Enum value JOURNEY_IN_PROGRESS was added to ContractStatus enum
  • Enum value TERMINATING was removed from ContractStatus enum
  • Field availableProducts was added to object type Query
  • Input Field specificationCode: String was added to input type CreateProductInput
  • Input Field specificationIdentifier removed from input type CreateProductInput
  • Field code of type String was added to interface RewardInterface
  • Field code was added to object type RewardType
  • Deprecation reason on field PaymentScheduleType.scheduleType changed from None to The 'scheduleType' field is deprecated. Use paymentPreferences query instead. - Marked as deprecated on 2025-07-07. - Scheduled for removal on or after 2026-07-07.
  • Field relayId was added to object type InkLiveChat
  • Field liveChatConversation was removed from object type InkLiveChat
  • Field id was removed from object type InkLiveChat
  • Input Field liveChatRelayId: ID! was added to input type SendLiveChatMessageInput
  • Input Field liveChatId removed from input type SendLiveChatMessageInput
  • Input Field funnelCode: String! was added to input type CreateOpportunityInput
  • Input Field funnelId removed from input type CreateOpportunityInput
  • Type LeaveSupplierInput was removed
  • Type _DefaultMarketTerminationInput was removed
  • Type CoreLeaveSupplierInput was added
  • Type ElectricityTerminationInput was added
  • Type LeaveSupplierReason was added
  • Type GasTerminationInput was added
  • Input Field gasSupplyPointData: [GasTerminationInput] was added to input type LeaveSupplierMarketInputType
  • Input Field electricitySupplyPointData: [ElectricityTerminationInput] was added to input type LeaveSupplierMarketInputType
  • Input Field supplyPointData removed from input type LeaveSupplierMarketInputType
  • Input Field requestedSupplyEndDate removed from input type UpdateLeaveSupplierInput
  • Type for argument input on field Mutation.instigateLeaveSupplier changed from LeaveSupplierInput! to CoreLeaveSupplierInput!
  • Field assigneeUsername was added to object type Reminder
  • Field reopenInkConversation was added to object type Reminder
  • Field assigneeTeamName was added to object type Reminder
  • Input Field assigneeUsername: String was added to input type CreateReminderInput
  • Input Field reopenInkConversation: Boolean was added to input type CreateReminderInput
  • Input Field assigneeTeamName: String was added to input type CreateReminderInput
  • Argument propertyId: Int added to Query.accountIoEligibility
  • Argument propertyId: Int added to Query.eligibleDeviceTypes
  • Input Field opportunityNumber: String! was added to input type UpdateOpportunityStageInput
  • Input Field opportunityId removed from input type UpdateOpportunityStageInput
  • UpdateOpportunityStageInput.stage type changed from String to String!
  • Input Field opportunityNumber: String! was added to input type UpdateExtraDetailsInput
  • Input Field opportunityId removed from input type UpdateExtraDetailsInput
  • Enum value BILLING_AMENDED_METER_READ_INTERVAL_LEGACY was removed from AccountReminderTypes enum
  • Enum value BILLING_AMENDED_INTERVAL_DATA_RECEIVED_CAUSING_OVERCHARGE was removed from AccountReminderTypes enum
  • Enum value OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_DELETED was removed from AccountReminderTypes enum
  • Enum value OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_CHANGED was removed from AccountReminderTypes enum
  • Enum value BILLING_BACKDATED_CONCESSION_RECEIVED was removed from AccountReminderTypes enum
  • Enum value BILLING_BACKDATED_UMS_RECORD_RECEIVED was removed from AccountReminderTypes enum
  • Deprecation reason on field Query.plannedDispatches changed from None to The 'plannedDispatches' field is deprecated. Please use 'flexPlannedDispatches' instead. - Marked as deprecated on 2025-05-27. - Scheduled for removal on or after 2025-08-27.
  • Type BaseInstigateAccountContractTerminationInput was added
  • Type for argument input on field Mutation.instigateAccountContractTermination changed from BaseInstigateContractTerminationInput! to BaseInstigateAccountContractTerminationInput!
  • Input Field partyIdentifier removed from input type BaseInstigateContractTerminationInput
  • Input Field lossReason removed from input type SetOpportunityOutcomeInput
  • Enum value CANCELLATION_PENDING was removed from RequestStatus enum
  • Enum value SENT_TO_MOP was removed from RequestStatus enum
  • Enum value FLOW_SENDING was removed from RequestStatus enum
  • Field title was added to object type Contract
  • Argument userNumber: String added to Mutation.updateAccountUserConsents
  • Deprecation reason on field Mutation.triggerBoostCharge changed from None to The 'triggerBoostCharge' field is deprecated. Please use 'updateBoostCharge' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12.
  • Deprecation reason on field Mutation.deleteBoostCharge changed from None to The 'deleteBoostCharge' field is deprecated. Please use 'updateBoostCharge' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12.
  • Deprecation reason on field Mutation.deauthenticateDevice changed from None to The 'deauthenticateDevice' field is deprecated. Please use 'deauthenticateFlexDevice' instead. - Marked as deprecated on 2025-05-12. - Scheduled for removal on or after 2025-08-12.