Mutations
Every GraphQL schema has a root type for both queries and
mutations. The mutation
type
defines GraphQL operations that change data on the server. It is
analogous to performing HTTP verbs such as POST,
PATCH, and DELETE.
- acceptGoodsQuote
- acceptOfferForQuoting
- actualizeContract
- addBusinessToSegment
- addCampaignToAccount
- addChildToProperty
- addComplaintNote
- addHistoricalCallParticipants
- addHistoricalCallRecordings
- addHistoricalCallTranscriptions
- addItemsToRiskList
- addNoteToInkConversation
- addOpportunityEvent
- addParentToProperty
- addPartnerUserToTeam
- addPortfolioReference
- addProperty
- addPropertyToHierarchy
- addSignupReferralOnAccount
- addStorylineToInkConversation
- addUserToPortfolio
- allowRepaymentSubmission
- amendContractSubject
- amendPayment
- annulOrder
- approveRepayment
- assessCollectionProcessRecordForPause
- assessCollectionProcessRecordForWithdrawal
- assignInkBucket
- assignSupplyPointToEstimationGroup
- associateArchivedCallRecordingsWithCalls
- associateCallWithAccount
- associateItemToCollectionProcess
- attachAgreementsToContracts
- awardLoyaltyPoints
- backendScreenEvent
- blockRepaymentSubmission
- bulkAwardLoyaltyPoints
- cancelContract
- cancelEnrollment
- cancelLeaveSupplier
- cancelOnSiteJobsAppointment
- cancelOnSiteJobsRequest
- cancelPayment
- cancelRepaymentRequest
- cancelSmartFlexOnboarding
- changeContractGroupComposition
- closeDcaProceeding
- closeInkConversation
- closeInkLiveChat
- closeOpenPrintBatch
- collectDeposit
- collectPayment
- commenceDcaProceeding
- completeApproval
- completeAuthFlowForSmartFlexOnboarding
- completeReminder
- completeRetryForSmartFlexOnboarding
- completeStandalonePayment
- completeTeslaSetupVirtualKeyForSmartFlexOnboarding
- completeUserActionForSmartFlexOnboarding
- completeUserInputRequiredForSmartFlexOnboarding
- confirmDoubleOptIn
- createAccountCharge
- createAccountFileAttachment
- createAccountManualHold
- createAccountNote
- createAccountPaymentSchedule
- createAccountReference
- createAccountReminder
- createAffiliateLink
- createAffiliateOrganisation
- createAffiliateSession
- createAgreement
- createAgreementRollover
- createApiCall
- createApiException
- createApiExceptionEvent
- createApiExceptionNote
- createAudioRecording
- createBusiness
- createCallMetadata
- createCampaignItems
- createCollectionProcessEvent
- createContract
- createContractGroup
- createContractGroupVersion
- createContributionAgreement
- createCreditTransferPermission
- createCustomerFeedback
- createDepositAgreement
- createDraftLegalEntity
- createElectricityMeterReadings
- createExternalAccountEvent
- createExternalAccountUserEvent
- createExternalMessage
- createExternalMessageEvent
- createFormSubmission
- createGasMeterReadings
- createGoodsPurchase
- createGoodsQuote
- createGoodsQuoteWithoutAccount
- createHistoricalCalls
- createInboundCall
- createInkInboundMessage
- createInkLiveChatMessage
- createInternalCompany
- createJoinSupplierSecurityDeposits
- createKnowledgeDatabaseArticleFromText
- createLead
- createLegalEntity
- createMetadata
- createMfaDevice
- createNewsletterSignup
- createOfferGroupForQuoting
- createOnSiteJobsAppointment
- createOnSiteJobsAppointmentWithDate
- createOnSiteJobsAppointmentWithoutBooking
- createOnSiteJobsAppointmentWithoutDateOrTime
- createOnSiteJobsRequest
- createOpportunityFileAttachment
- createOpportunityForLead
- createOrganisationFileUpload
- createOrUpdateLoyaltyCard
- createOrUpdateProductPrices
- createOrUpdateTemperatureCurveDatapoints
- createOrUpdateTimeSeriesEntries
- createPartnerUser
- createPaymentActionIntent
- createPaymentMethodActionIntent
- createPortfolio
- createPortfolioUserRole
- createPostEvents
- createProduct
- createQuote
- createQuoteForAccount
- createReferral
- createReminder
- createScheduledTransactions
- createShellAccount
- createTimeSeriesPrices
- deauthenticateDevice
- deauthenticateFlexDevice
- deductLoyaltyPoints
- deleteAccountReference
- deleteBoostCharge
- deleteKnowledgeDatabaseArticle
- deleteMfaDevice
- deletePropertyDescendants
- deletePushNotificationBinding
- detachAgreementsFromContracts
- detachSupplyPointFromEstimationGroup
- deviceRegistration
- endContributionAgreement
- enqueueInboundCall
- enrollAccountInLoyaltyProgram
- enrollFanClubAccount
- enrollment
- escalateInkConversation
- extendAgreementPeriod
- fanClubDiscountNotification
- fanClubNonOctopusCustomerComms
- fetchGeneratePaymentFingerprint
- fetchPreSignedLinkForOpportunityAttachment
- forceReauthentication
- generateAffiliatesAudioRecordingPreSignedUrl
- generateExternalMessagingUploadUrl
- generateInkPresignedUrl
- generateLeadsFileAttachmentDownloadPreSignedUrl
- generateLeadsFileAttachmentPreSignedUrl
- generateOrganisationFileUploadPreSignedUrl
- generatePreSignedToken
- getEmbeddedSecretForNewPaymentInstruction
- getEmbeddedSecretForNewPaymentInstructionWithoutAccount
- getHostedUrlForNewPaymentInstruction
- getOrCreateAgreement
- grantUserAccessToBusiness
- importTrancheRate
- initializeAccount
- initializeUser
- initiateAgreementRescission
- initiateHostedStandalonePayment
- initiateProductSwitch
- initiateStandalonePayment
- instigateLeaveSupplier
- instigateLeaveSupplierForCollectionProcess
- invalidatePaymentInstruction
- invalidatePreSignedToken
- invalidatePreSignedTokensForUser
- invalidateRefreshToken
- invalidateRefreshTokensForUser
- joinSupplierAcceptTermsAndConditions
- linkAccountToBusiness
- linkCustomerBusinessToLegalEntity
- linkInternalCompanyToLegalEntity
- linkPartnerToLegalEntity
- linkUserToLine
- markPrintBatchAsProcessed
- masqueradeAuthentication
- moveOut
- moveToBucket
- nextOperationsTeamRoundRobin
- obtainKrakenToken
- obtainLongLivedRefreshToken
- ocppAuthentication
- pauseCollectionProcess
- pauseDunning
- payoutReferralForAccount
- performHouseMove
- pickTimeslotForOnSiteJobsAppointment
- placeGridDisconnectionOrder
- placeGridReconnectionOrder
- postCredit
- prepareAccount
- productSwitch
- publishTransactionalMessagingExternalTrigger
- publishTransactionalMessagingTrigger
- purchaseVoucher
- purchaseVouchers
- reactivateCollectionProcessRecord
- recordActivatedPaymentMethod
- recordCancelledPayment
- recordChargedBackPayment
- recordDepositAgreementAccepted
- recordFailedPayment
- recordFailedPayout
- recordInitiatedPayment
- recordInitiatedPayout
- recordInvalidatedPaymentMethod
- recordPendingPayment
- recordSalesInteraction
- recordSuccessfulPayment
- recordSuccessfulPayout
- redeemLoyaltyPointsForAccountCredit
- redeemReferralClaimCode
- refundPayment
- refundVoucher
- regenerateSecretKey
- registerCustomerAsset
- registerLeadFlowStatusEvent
- registerOpportunityFlowStatusEvent
- registerPushNotificationBinding
- removeBankDetailsForLead
- removeCampaignFromAccount
- removeCampaignItems
- removeItemsFromRiskList
- removePartnerUserFromTeam
- removePropertyFromHierarchy
- replacePartnerReferences
- requestDoubleOptIn
- requestGridConnectionOrderAnnulation
- requestPasswordReset
- requestPrintedBill
- rescindContract
- resetPassword
- resetUserPassword
- restorePreviousAgreement
- resumeCollectionProcess
- resumeControl
- retireCustomerAsset
- reverseEnrollment
- reverseLeaveSupplier
- revokeAgreement
- revokeContract
- revokePartnerUserAccess
- revokeSupplyContract
- revokeUserAccessFromBusiness
- runAgreementRollover
- saveCreditCheckOutcome
- saveLeadLegalEntity
- scheduleQuoteFollowUp
- selectChargePointMakeForSmartFlexOnboarding
- selectChargePointVariantForSmartFlexOnboarding
- selectDeviceTypeForSmartFlexOnboarding
- selectFromListForSmartFlexOnboarding
- selectInverterMakeForSmartFlexOnboarding
- selectProducts
- selectUserVehicleForSmartFlexOnboarding
- selectVehicleMakeForSmartFlexOnboarding
- selectVehicleOrChargePointForSmartFlexOnboarding
- selectVehicleVariantForSmartFlexOnboarding
- sendAgreementRescissionConfirmation
- sendInkOutboundMessage
- sendOfferQuoteSummary
- sendQuoteSummary
- sendTrustpilotReviewInvitation
- sendVerificationEmail
- setDevicePreferences
- setInverterPreferences
- setLoyaltyPointsUser
- setOpportunityOutcome
- setPaymentPreference
- setQuoteConfigurationRatesRequestErrors
- setScheduleCollectionMethod
- setUpDirectDebitInstruction
- setUpDirectDebitInstructionForBusiness
- setUpDirectDebitInstructionFromStoredDetails
- setVehicleChargePreferences
- shareGoodsQuote
- specialCancelContract
- startCollectionProcess
- startCustomerVerification
- startGroupedCollectionProcess
- startOnSiteJobsAppointmentBookingSession
- startOnSiteJobsAppointmentBookingSessionForDraftAppointment
- startOnSiteJobsAppointmentBookingSessionForRequest
- startOnSiteJobsAppointmentReschedulingSession
- startOnSiteJobsTimeslotPickingSession
- startReAuthentication
- startSmartFlexOnboarding
- startTestChargeForSmartFlexOnboarding
- stopAutomatedPayments
- storeBankDetailsForLead
- storeDirectDebitPaymentMethodDetails
- storePaymentInstruction
- submitAllowedRepayment
- submitCustomerFeedback
- submitRepaymentRequest
- submitSupplyPointReadings
- suspendControl
- switchAccountToVariablePaymentSchedule
- terminateAgreement
- terminateContract
- terminateCreditTransferPermission
- thirdPartyCompleteDeviceRegistration
- transferLeadOpportunities
- transferLedgerBalance
- transferLoyaltyPointsBetweenUsers
- triggerBoostCharge
- triggerCollectionProcessMessage
- triggerPostUploadOperations
- triggerStandalonePaymentRequest
- triggerTestCharge
- unenrollAccountFromLoyaltyProgram
- unlinkCustomerBusinessFromLegalEntity
- unlinkInternalCompanyFromLegalEntity
- unlinkPartnerFromLegalEntity
- unlinkUserFromLine
- updateAccountBillingAddress
- updateAccountBillingEmail
- updateAccountBillingName
- updateAccountConsents
- updateAccountReference
- updateAccountReferralStatus
- updateAccountUserConsents
- updateActivePurchase
- updateAffiliateLink
- updateAffiliateOrganisation
- updateAgentAuxiliaryStatus
- updateAgreementPeriod
- updateAgreementRescission
- updateAgreementRollover
- updateApiException
- updateApiExceptionNote
- updateAutoTopUpAmount
- updateBoostCharge
- updateBusiness
- updateCampaignAccountExpiryDate
- updateCollectionProcessRecordLatestStep
- updateCollectionProcessRecordToActive
- updateCollectionProcessRecordToComplete
- updateCommsDeliveryPreference
- updateCommsPreferences
- updateDcaProceeding
- updateDeviceGridExport
- updateDeviceSmartControl
- updateDocumentAccessibilityPreference
- updateIsChargingDurationCapped
- updateKnowledgeDatabaseArticleFromText
- updateLeadContacts
- updateLeadDetails
- updateLeadStage
- updateLeaveSupplier
- updateLegalEntity
- updateMessageTags
- updateMetadata
- updateNotesOnOpportunity
- updateOfferGroupOnOpportunity
- updateOnSiteJobsAppointment
- updateOnSiteJobsRequest
- updateOnSiteJobsVendorComplaint
- updateOpportunityAddress
- updateOpportunityAssignment
- updateOpportunityDetails
- updateOpportunityExtraDetails
- updateOpportunityProductSelection
- updateOpportunitySalesDetails
- updateOpportunityStage
- updateOpportunitySupplyPoints
- updateOptionsLanguagePreference
- updatePassword
- updatePaymentSchedulePaymentAmount
- updatePaymentSchedulePaymentDay
- updatePortfolioOperationsTeam
- updateProductPrices
- updatePropertyAddress
- updateQuoteConfiguration
- updateSiteworksRequest
- updateUser
- updateUserDetails
- validateAddress
- validateAgreementRollover
- validateEmail
- validateMfaDevice
- validatePhone
- validateSupplyPoint
- varyContractTerms
- verifyCustomer
- verifyEmail
- verifyEmailWithTokenPair
- verifyIdentity
- verifyPayerBankAccountDetails
- withdrawDunning