Octopus Energy

Accept a goods quote.

The possible errors that can be raised are:

KT-CT-8223: Unauthorized.
KT-CT-8201: Received an invalid quoteId.
KT-CT-8224: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AcceptGoodsQuoteInput!`)	Input fields for accepting a quote.

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

goodsPurchase (GoodsPurchase)

Goods purchase created.

mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
  acceptGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": AcceptGoodsQuoteInput
}

{
  "data": {
    "acceptGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

acceptOfferForQuoting

Type:AcceptOfferForQuoting

Accept a quoting offer in an offer group.

The possible errors that can be raised are:

KT-CT-12402: Unable to accept offer.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AcceptOfferForQuotingInput!`)	Input fields for accepting a quoting offer.

input (AcceptOfferForQuotingInput!)

Input fields for accepting a quoting offer.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

offer (OfferType)

Accepted quoting offer.

mutation AcceptOfferForQuoting($input: AcceptOfferForQuotingInput!) {
  acceptOfferForQuoting(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    offer {
      ...OfferTypeFragment
    }
  }
}

{
  "input": AcceptOfferForQuotingInput
}

{
  "data": {
    "acceptOfferForQuoting": {
      "possibleErrors": [PossibleErrorType],
      "offer": OfferType
    }
  }
}

acceptTermsAndConditions

Type:AcceptTermsAndConditions

Accept the terms and conditions.

Arguments

Name Description

Name	Description
`input` (`AcceptTermsAndConditionsInput!`)	Input fields for accepting terms and conditions.

input (AcceptTermsAndConditionsInput!)

Input fields for accepting terms and conditions.

Return fields

Name Description

Name	Description
`acceptedVersion` (`String`)	Version of terms and conditions that were accepted.

acceptedVersion (String)

Version of terms and conditions that were accepted.

mutation AcceptTermsAndConditions($input: AcceptTermsAndConditionsInput!) {
  acceptTermsAndConditions(input: $input) {
    acceptedVersion
  }
}

{
  "input": AcceptTermsAndConditionsInput
}

{
  "data": {
    "acceptTermsAndConditions": {
      "acceptedVersion": "abc123"
    }
  }
}

actualizeContract

Type:ActualizeContractOutput!

Actualize a contract for an account or business.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10007: Unable to terminate contract.
KT-CT-10008: The contract is currently undergoing an active journey.
KT-CT-10022: Contract already terminated.
KT-CT-10023: Contract is already revoked.
KT-CT-10024: Contract already expired.
KT-CT-10026: Contract actualization implies breach.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`ActualizeContractInput!`)

input (ActualizeContractInput!)

Return fields

Name	Description

mutation ActualizeContract($input: ActualizeContractInput!) {
  actualizeContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

{
  "input": ActualizeContractInput
}

{
  "data": {
    "actualizeContract": {
      "contract": Contract
    }
  }
}

addBusinessToSegment

Type:AddBusinessToSegmentMutation

Add a business to a segment.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11107: Unauthorized.
KT-CT-11111: Segment does not exist.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddBusinessToSegmentInput!`)	Input fields for adding a business to a segment.

input (AddBusinessToSegmentInput!)

Input fields for adding a business to a segment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

businessSegmentPeriod (BusinessSegmentPeriodType)

The business segment period that was created.

mutation AddBusinessToSegment($input: AddBusinessToSegmentInput!) {
  addBusinessToSegment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    businessSegmentPeriod {
      ...BusinessSegmentPeriodTypeFragment
    }
  }
}

{
  "input": AddBusinessToSegmentInput
}

{
  "data": {
    "addBusinessToSegment": {
      "possibleErrors": [PossibleErrorType],
      "businessSegmentPeriod": BusinessSegmentPeriodType
    }
  }
}

addCampaignToAccount

Type:AddCampaignToAccount

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-7427: No campaign found with given slug.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddCampaignToAccountInput!`)	Input variables needed for adding a campaign to an account.

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignAdded (Boolean)

Whether the campaign was successfully added.

mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
  addCampaignToAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignAdded
  }
}

{
  "input": AddCampaignToAccountInput
}

{
  "data": {
    "addCampaignToAccount": {
      "possibleErrors": [PossibleErrorType],
      "campaignAdded": true
    }
  }
}

addChildToProperty

Type:AddChildToProperty

Add a child property to a parent property in a hierarchy.

If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-6622: Unauthorized.
KT-CT-6634: Unable to add child to property.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddChildToPropertyInput!`)	Input fields for adding a child to a parent property.

input (AddChildToPropertyInput!)

Input fields for adding a child to a parent property.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

child (PropertyType)

The child property that was added to the parent.

mutation AddChildToProperty($input: AddChildToPropertyInput!) {
  addChildToProperty(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    child {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": AddChildToPropertyInput
}

{
  "data": {
    "addChildToProperty": {
      "possibleErrors": [PossibleErrorType],
      "child": PropertyType
    }
  }
}

addCreditToSmartMeter

Type:AddCreditToSmartMeter

Add credit to a smart prepay meter

Arguments

Name Description

Name	Description
`input` (`SmartPrepayMeterAmountInput!`)	Controls which meter to top-up and by how much.

input (SmartPrepayMeterAmountInput!)

Controls which meter to top-up and by how much.

Return fields

Name Description

Name	Description
`amount` (`Int!`)	Top-up amount in pence to add to smart meter.

amount (Int!)

Top-up amount in pence to add to smart meter.

mutation AddCreditToSmartMeter($input: SmartPrepayMeterAmountInput!) {
  addCreditToSmartMeter(input: $input) {
    amount
  }
}

{
  "input": SmartPrepayMeterAmountInput
}

{
  "data": {
    "addCreditToSmartMeter": {
      "amount": 1
    }
  }
}

addEvPublicChargingToken

Type:AddEvPublicChargingToken

Add EV public charging token.

The possible errors that can be raised are:

KT-CT-5817: External Account not found.
KT-CT-5812: Token with this value already exists within this period.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddEvPublicChargingTokenInput!`)	Input fields for adding a token.

input (AddEvPublicChargingTokenInput!)

Input fields for adding a token.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (Token)

mutation AddEvPublicChargingToken($input: AddEvPublicChargingTokenInput!) {
  addEvPublicChargingToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...TokenFragment
    }
  }
}

{
  "input": AddEvPublicChargingTokenInput
}

{
  "data": {
    "addEvPublicChargingToken": {
      "possibleErrors": [PossibleErrorType],
      "token": Token
    }
  }
}

addItemsToRiskList

Type:AddItemsToRiskList

Add items to the risk list.

The possible errors that can be raised are:

KT-CT-12105: Risk list item addition failed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`[RiskListItemInputType]!`)	A list of risk list items to add.

input ([RiskListItemInputType]!)

A list of risk list items to add.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

riskIdentifiers ([RiskListItemType])

List of successfully added risk identifiers.

mutation AddItemsToRiskList($input: [RiskListItemInputType]!) {
  addItemsToRiskList(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    riskIdentifiers {
      ...RiskListItemTypeFragment
    }
  }
}

{
  "input": RiskListItemInputType
}

{
  "data": {
    "addItemsToRiskList": {
      "possibleErrors": [PossibleErrorType],
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

addNoteToInkConversation

Type:AddNoteToInkConversation

The possible errors that can be raised are:

KT-CT-7612: The Ink conversation was not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddNoteToInkConversationInput`)

input (AddNoteToInkConversationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

note (InkNote)

The ink conversation note.

mutation AddNoteToInkConversation($input: AddNoteToInkConversationInput) {
  addNoteToInkConversation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    note {
      ...InkNoteFragment
    }
  }
}

{
  "input": AddNoteToInkConversationInput
}

{
  "data": {
    "addNoteToInkConversation": {
      "possibleErrors": [PossibleErrorType],
      "note": InkNote
    }
  }
}

addParentToProperty

Type:AddParentToProperty

Add a parent property to a child property in a hierarchy.

If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-6622: Unauthorized.
KT-CT-6635: Unable to add parent to property.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddParentToPropertyInput!`)	Input fields for adding a parent to a child property.

input (AddParentToPropertyInput!)

Input fields for adding a parent to a child property.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

parent (PropertyType)

The parent property that was added to the child.

mutation AddParentToProperty($input: AddParentToPropertyInput!) {
  addParentToProperty(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    parent {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": AddParentToPropertyInput
}

{
  "data": {
    "addParentToProperty": {
      "possibleErrors": [PossibleErrorType],
      "parent": PropertyType
    }
  }
}

addPortfolioReference

Type:AddPortfolioReference

Mutation to add a reference to an existing portfolio.

The possible errors that can be raised are:

KT-CT-9403: Received an invalid portfolioId.
KT-CT-9410: Conflicting portfolio reference.
KT-CT-9408: Invalid portfolio number format.
KT-CT-9409: Invalid portfolio reference.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddPortfolioReferenceInput`)	Input fields for adding a reference to a portfolio.

input (AddPortfolioReferenceInput)

Input fields for adding a reference to a portfolio.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation AddPortfolioReference($input: AddPortfolioReferenceInput) {
  addPortfolioReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": AddPortfolioReferenceInput
}

{
  "data": {
    "addPortfolioReference": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

addProperty

Type:AddProperty

Add a property to an account.

The possible errors that can be raised are:

KT-CT-6623: Unauthorized.
KT-CT-6629: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddPropertyInput!`)	Input fields for adding a property to an account.

input (AddPropertyInput!)

Input fields for adding a property to an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

property (PropertyType)

The property that was added to the account.

mutation AddProperty($input: AddPropertyInput!) {
  addProperty(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    property {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": AddPropertyInput
}

{
  "data": {
    "addProperty": {
      "possibleErrors": [PossibleErrorType],
      "property": PropertyType
    }
  }
}

addPropertyToHierarchy

Type:AddPropertyToHierarchy

Add a property to a hierarchy as a root node.

If the property is already a root node in the hierarchy, this operation is idempotent. If the property is already in the hierarchy as a child, an error will be raised.

The possible errors that can be raised are:

KT-CT-6622: Unauthorized.
KT-CT-6633: Property is already in the hierarchy as a child.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddPropertyToHierarchyInput!`)	Input fields for adding a property to a hierarchy.

input (AddPropertyToHierarchyInput!)

Input fields for adding a property to a hierarchy.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

property (PropertyType)

The property that was added to the hierarchy.

mutation AddPropertyToHierarchy($input: AddPropertyToHierarchyInput!) {
  addPropertyToHierarchy(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    property {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": AddPropertyToHierarchyInput
}

{
  "data": {
    "addPropertyToHierarchy": {
      "possibleErrors": [PossibleErrorType],
      "property": PropertyType
    }
  }
}

addSignupReferralOnAccount

Type:AddSignupReferralOnAccount

Add a one-way signup reward to a referral.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6729: This scheme cannot be applied to given account.
KT-CT-6710: Unable to create referral.
KT-CT-6728: This referral scheme's usage is at capacity.
KT-CT-6712: Invalid reference.
KT-CT-6713: Referring and referred account brands do not match.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddSignupReferralOnAccountInput!`)	Input fields for creating a signup reward for an organization.

input (AddSignupReferralOnAccountInput!)

Input fields for creating a signup reward for an organization.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReferral (ReferralType)

The created account referral instance.

mutation AddSignupReferralOnAccount($input: AddSignupReferralOnAccountInput!) {
  addSignupReferralOnAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

{
  "input": AddSignupReferralOnAccountInput
}

{
  "data": {
    "addSignupReferralOnAccount": {
      "possibleErrors": [PossibleErrorType],
      "accountReferral": ReferralType
    }
  }
}

addStorylineToInkConversation

Type:AddStorylineToInkConversation

The possible errors that can be raised are:

KT-CT-7612: The Ink conversation was not found.
KT-CT-7651: Only one storyline entry can be marked as the root cause.
KT-CT-7657: The provided analyzer result data is invalid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddStorylineToInkConversationInput`)

input (AddStorylineToInkConversationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

storyline (InkStoryline)

The storyline that was added to the conversation.

mutation AddStorylineToInkConversation($input: AddStorylineToInkConversationInput) {
  addStorylineToInkConversation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    storyline {
      ...InkStorylineFragment
    }
  }
}

{
  "input": AddStorylineToInkConversationInput
}

{
  "data": {
    "addStorylineToInkConversation": {
      "possibleErrors": [PossibleErrorType],
      "storyline": InkStoryline
    }
  }
}

addUserToPortfolio

Type:AddUserToPortfolio

Add an user to a portfolio with a specified role.

The possible errors that can be raised are:

KT-CT-5461: Invalid role code.
KT-CT-5462: Invalid user number format.
KT-CT-5463: Unauthorized.
KT-CT-9407: Unauthorized.
KT-CT-9408: Invalid portfolio number format.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddUserToPortfolioInput!`)	Input fields for adding a user to a portfolio.

input (AddUserToPortfolioInput!)

Input fields for adding a user to a portfolio.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation AddUserToPortfolio($input: AddUserToPortfolioInput!) {
  addUserToPortfolio(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": AddUserToPortfolioInput
}

{
  "data": {
    "addUserToPortfolio": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

allowRepaymentSubmission

Type:AllowRepaymentSubmission

Allow a repayment to be submitted.

The possible errors that can be raised are:

KT-CT-3944: Account repayment does not exist.
KT-CT-3945: Unable to allow a repayment to be submitted.
KT-CT-3950: The provided reason text is too long.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`RepaymentInput!`)	Input variable needed for allowing repayment submission.

input (RepaymentInput!)

Input variable needed for allowing repayment submission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

mutation AllowRepaymentSubmission($input: RepaymentInput!) {
  allowRepaymentSubmission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentId
    repaymentIntervention {
      ...RepaymentInterventionTypeFragment
    }
  }
}

{
  "input": RepaymentInput
}

{
  "data": {
    "allowRepaymentSubmission": {
      "possibleErrors": [PossibleErrorType],
      "repaymentId": "abc123",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

amendPayment

Type:AmendPayment

Amend an existing payment.

The possible errors that can be raised are:

KT-CT-3924: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-3970: The account cannot amend payments.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AmendPaymentInput!`)	Input fields for amending an existing payment.

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (AccountPaymentType)

mutation AmendPayment($input: AmendPaymentInput!) {
  amendPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": AmendPaymentInput
}

{
  "data": {
    "amendPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

amendUnbilledElectricityReading

Type:AmendUnbilledElectricityReading

Amend unbilled electricity readings.

Arguments

Name Description

Name	Description
`input` (`AmendUnbilledReadingInput!`)	Input fields for amending unbilled electricity reading.

input (AmendUnbilledReadingInput!)

Input fields for amending unbilled electricity reading.

Return fields

Name Description

Name	Description
`readingAmended` (`Boolean`)

readingAmended (Boolean)

mutation AmendUnbilledElectricityReading($input: AmendUnbilledReadingInput!) {
  amendUnbilledElectricityReading(input: $input) {
    readingAmended
  }
}

{
  "input": AmendUnbilledReadingInput
}

{
  "data": {
    "amendUnbilledElectricityReading": {
      "readingAmended": true
    }
  }
}

approveRepayment

Type:ApproveRepayment

Approve a repayment.

The possible errors that can be raised are:

KT-CT-3934: Repayment request already approved.
KT-CT-3935: Repayment request cannot be paid.
KT-CT-3959: Unauthorized.
KT-CT-3973: Repayment request is not in a state to be approved.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`ApproveRepaymentInput!`)	Input fields for approving a repayment.

input (ApproveRepaymentInput!)

Input fields for approving a repayment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repayment (AccountRepaymentType)

The approved repayment.

mutation ApproveRepayment($input: ApproveRepaymentInput!) {
  approveRepayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repayment {
      ...AccountRepaymentTypeFragment
    }
  }
}

{
  "input": ApproveRepaymentInput
}

{
  "data": {
    "approveRepayment": {
      "possibleErrors": [PossibleErrorType],
      "repayment": AccountRepaymentType
    }
  }
}

assessCollectionProcessRecordForPause

Type:AssessCollectionProcessRecordForPause

Assess a collection process record for pause.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AssessCollectionProcessRecordForPauseInputType!`)	Details of collection process to run the pause assessment.

input (AssessCollectionProcessRecordForPauseInputType!)

Details of collection process to run the pause assessment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessProcessed (AssessCollectionProcessRecordForPauseOutputType)

Details of collection process after running the pause assessment.

mutation AssessCollectionProcessRecordForPause($input: AssessCollectionProcessRecordForPauseInputType!) {
  assessCollectionProcessRecordForPause(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessProcessed {
      ...AssessCollectionProcessRecordForPauseOutputTypeFragment
    }
  }
}

{
  "input": AssessCollectionProcessRecordForPauseInputType
}

{
  "data": {
    "assessCollectionProcessRecordForPause": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
    }
  }
}

assignInkBucket

Type:AssignInkBucket

The possible errors that can be raised are:

KT-CT-7612: The Ink conversation was not found.
KT-CT-7613: The Ink bucket was not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AssignInkBucketInput`)

input (AssignInkBucketInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

conversation (InkConversation!)

The conversation that will be assigned to the bucket.

bucket (InkBucket!)

The bucket that the conversation will be assigned to.

mutation AssignInkBucket($input: AssignInkBucketInput) {
  assignInkBucket(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    conversation {
      ...InkConversationFragment
    }
    bucket {
      ...InkBucketFragment
    }
  }
}

{
  "input": AssignInkBucketInput
}

{
  "data": {
    "assignInkBucket": {
      "possibleErrors": [PossibleErrorType],
      "conversation": InkConversation,
      "bucket": InkBucket
    }
  }
}

assignSupplyPointToEstimationGroup

Type:AssignSupplyPointToEstimationGroup

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-13601: Estimation Group does not exist.
KT-CT-13602: Supply Point already has an Estimation Group.
KT-CT-13603: Supply Point does not exist.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AssignSupplyPointToEstimationGroupInput!`)	Input fields for assigning a supply point to an estimation group.

input (AssignSupplyPointToEstimationGroupInput!)

Input fields for assigning a supply point to an estimation group.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

supplyPointEstimationGroup (AssignedSupplyPointEstimationGroupType)

The created supply point estimation group mapping.

mutation AssignSupplyPointToEstimationGroup($input: AssignSupplyPointToEstimationGroupInput!) {
  assignSupplyPointToEstimationGroup(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    supplyPointEstimationGroup {
      ...AssignedSupplyPointEstimationGroupTypeFragment
    }
  }
}

{
  "input": AssignSupplyPointToEstimationGroupInput
}

{
  "data": {
    "assignSupplyPointToEstimationGroup": {
      "possibleErrors": [PossibleErrorType],
      "supplyPointEstimationGroup": AssignedSupplyPointEstimationGroupType
    }
  }
}

associateCallWithAccount

Type:AssociateCallWithAccount

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-11802: Call not found.
KT-CT-11808: Unable to associate account to call.
KT-CT-11817: Invalid call ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AssociateCallWithAccountInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

call (InboundCallType)

The call.

mutation AssociateCallWithAccount($input: AssociateCallWithAccountInput!) {
  associateCallWithAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

{
  "input": AssociateCallWithAccountInput
}

{
  "data": {
    "associateCallWithAccount": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

associateItemToCollectionProcess

Type:AssociateItemToCollectionProcess

Associate item to a collection process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11205: Item already associated to collection process.
KT-CT-11216: Invalid extra_details for associated item type.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AssociateItemToCollectionProcessInputType!)

Input variables needed for associating an item to collection process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessAssociatedItem (AssociateItemToCollectionProcessOutputType)

Item associated to the collection process.

mutation AssociateItemToCollectionProcess($input: AssociateItemToCollectionProcessInputType!) {
  associateItemToCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessAssociatedItem {
      ...AssociateItemToCollectionProcessOutputTypeFragment
    }
  }
}

{
  "input": AssociateItemToCollectionProcessInputType
}

{
  "data": {
    "associateItemToCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
    }
  }
}

awardLoyaltyPoints

Type:AwardLoyaltyPoints

Award the passed number of Loyalty Points to the account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9202: Loyalty Points adapter not configured.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-9212: Points exceed maximum limit.
KT-CT-9219: Loyalty points user not found.
KT-CT-9221: Idempotency key already used on ledger entry.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AwardLoyaltyPointsInput!)

Input fields for awarding Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsAwarded (Int)

The number of loyalty points that were awarded.

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the awarded loyalty points.

mutation AwardLoyaltyPoints($input: AwardLoyaltyPointsInput!) {
  awardLoyaltyPoints(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsAwarded
    ledgerEntry {
      ...LoyaltyPointLedgerEntryTypeFragment
    }
  }
}

{
  "input": AwardLoyaltyPointsInput
}

{
  "data": {
    "awardLoyaltyPoints": {
      "possibleErrors": [PossibleErrorType],
      "pointsAwarded": 1,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

backendScreenEvent

Type:BackendScreenEvent

Look up an event to perform from its event_id, and return the next action to perform.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-8002: No event found.
KT-CT-8003: Event has no execute function.
KT-CT-8004: Error executing event in the backend.
KT-CT-8007: Incorrect or missing parameters for backend screen event.
KT-GB-9310: Account ineligible for joining Octoplus.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

action (ActionType)

An action to perform.

mutation BackendScreenEvent($input: BackendScreenEventInput!) {
  backendScreenEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    action {
      ... on DeeplinkActionType {
        ...DeeplinkActionTypeFragment
      }
      ... on LinkActionType {
        ...LinkActionTypeFragment
      }
      ... on BackendScreenEventActionType {
        ...BackendScreenEventActionTypeFragment
      }
      ... on CloseActionType {
        ...CloseActionTypeFragment
      }
      ... on ScreenActionType {
        ...ScreenActionTypeFragment
      }
      ... on ShowInputFieldErrorsActionType {
        ...ShowInputFieldErrorsActionTypeFragment
      }
    }
  }
}

{
  "input": BackendScreenEventInput
}

{
  "data": {
    "backendScreenEvent": {
      "possibleErrors": [PossibleErrorType],
      "action": DeeplinkActionType
    }
  }
}

billToLatestSmartMeterSnapshot

Type:BillToLatestSmartMeterSnapshot

Bill to latest smart meter snapshot.

Arguments

Name Description

input (BillToLatestSmartMeterSnapshotInput!)

Input fields for billing to latest smart meter snapshot.

Return fields

Name Description

billedToDate (Date)

The date that has been billed up to.

currentBalance (Decimal)

The balance after attempting to bill.

mutation BillToLatestSmartMeterSnapshot($input: BillToLatestSmartMeterSnapshotInput!) {
  billToLatestSmartMeterSnapshot(input: $input) {
    billedToDate
    currentBalance
  }
}

{
  "input": BillToLatestSmartMeterSnapshotInput
}

{
  "data": {
    "billToLatestSmartMeterSnapshot": {
      "billedToDate": "2020-01-01",
      "currentBalance": "1.0"
    }
  }
}

blockRepaymentSubmission

Type:BlockRepaymentSubmission

Block a repayment from being submitted.

The possible errors that can be raised are:

KT-CT-3944: Account repayment does not exist.
KT-CT-3946: Unable to block a repayment from being submitted.
KT-CT-3950: The provided reason text is too long.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RepaymentInput!)

Input variable needed for blocking repayment submission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

mutation BlockRepaymentSubmission($input: RepaymentInput!) {
  blockRepaymentSubmission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentId
    repaymentIntervention {
      ...RepaymentInterventionTypeFragment
    }
  }
}

{
  "input": RepaymentInput
}

{
  "data": {
    "blockRepaymentSubmission": {
      "possibleErrors": [PossibleErrorType],
      "repaymentId": "abc123",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

bulkUpdateSensorDisplayName

Type:BulkUpdateSensorDisplayName

Update the display name of multiple sensors.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'bulkUpdateSensorDisplayName' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

updates ([SensorDisplayNameUpdate]!)

A list of sensor codes and display names to set.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionIds ([SensorUpdateTransactionId])

A mapping of transaction ids for each sensor.

mutation BulkUpdateSensorDisplayName(
  $accountNumber: String!,
  $euid: ID!,
  $updates: [SensorDisplayNameUpdate]!
) {
  bulkUpdateSensorDisplayName(
    accountNumber: $accountNumber,
    euid: $euid,
    updates: $updates
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionIds {
      ...SensorUpdateTransactionIdFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "updates": SensorDisplayNameUpdate
}

{
  "data": {
    "bulkUpdateSensorDisplayName": {
      "possibleErrors": [PossibleErrorType],
      "transactionIds": [SensorUpdateTransactionId]
    }
  }
}

calculateDepositAmount

Type:CalculateDepositAmount

Calculate the deposit amount. Record the deposit amount and return the key

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

calculateDepositAmountInput (CalculateDepositAmountInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

depositAmount (Int)

Security deposit amount in pence.

key (String)

unique key of the record inserted in DepositAmount model.

mutation CalculateDepositAmount($calculateDepositAmountInput: CalculateDepositAmountInput!) {
  calculateDepositAmount(calculateDepositAmountInput: $calculateDepositAmountInput) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    depositAmount
    key
  }
}

{
  "calculateDepositAmountInput": CalculateDepositAmountInput
}

{
  "data": {
    "calculateDepositAmount": {
      "possibleErrors": [PossibleErrorType],
      "depositAmount": 1,
      "key": "abc123"
    }
  }
}

cancelEnrollment

Type:EnrollmentCancelled!

Cancel an enrollment for an account and a set of supply points.

The possible errors that can be raised are:

KT-CT-10312: Mutation not enabled in this environment.
KT-CT-10318: Enrollment process not found.
KT-CT-10319: Enrollment process failed to cancel.
KT-CT-10320: Enrollment process not cancellable.
KT-CT-10321: Enrollment cancellation workflow not defined.
KT-CT-10323: Enrollment process failed to cancel.
KT-CT-10338: Enrollment process cannot be cancelled.
KT-CT-10331: Missing required process number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelEnrollmentInput!)

Return fields

Name	Description

mutation CancelEnrollment($input: CancelEnrollmentInput!) {
  cancelEnrollment(input: $input) {
    message
    enrollmentProcess {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
  }
}

{
  "input": CancelEnrollmentInput
}

{
  "data": {
    "cancelEnrollment": {
      "message": "abc123",
      "enrollmentProcess": JoinSupplierProcessType
    }
  }
}

cancelEnrolment

Type:CancelEnrolment

Cancel the enrolment of an account to a supplier.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-GB-4136: Account cannot be withdrawn.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelEnrolmentInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountNumber (String)

The number of the account whose enrolment was cancelled.

mutation CancelEnrolment($input: CancelEnrolmentInput) {
  cancelEnrolment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
  }
}

{
  "input": CancelEnrolmentInput
}

{
  "data": {
    "cancelEnrolment": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "abc123"
    }
  }
}

cancelLeaveSupplier

Type:LeaveSupplierCancelled!

Cancel a leave supplier process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-10302: Invalid data.
KT-CT-10305: Failed to cancel leave supplier process - market actions are no longer cancellable.
KT-CT-10306: Failed to cancel leave supplier process - the cancellation workflow has not been configured.
KT-CT-10307: Failed to cancel leave supplier process - failed to cancel market actions.
KT-CT-10308: Failed to cancel leave supplier process.
KT-CT-10311: Failed to cancel leave supplier process. The process status is not in cancellable status.
KT-CT-1607: Value cannot be empty.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelLeaveSupplierInput!)

Return fields

Name	Description

mutation CancelLeaveSupplier($input: CancelLeaveSupplierInput!) {
  cancelLeaveSupplier(input: $input) {
    message
  }
}

{
  "input": CancelLeaveSupplierInput
}

{
  "data": {
    "cancelLeaveSupplier": {
      "message": "abc123"
    }
  }
}

cancelOnSiteJobsAppointment

Type:CancelOnSiteJobsAppointment

Cancel an Appointment.

The possible errors that can be raised are:

KT-CT-13001: Appointment does not exist.
KT-CT-13019: Vendor not found.
KT-CT-13017: Appointment cancellation not supported.
KT-CT-13053: Failed to cancel the appointment with the agent.
KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
KT-CT-13043: Cannot update appointment as it has terminal status.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelOnSiteJobsAppointmentInputType!)

The input objects required to cancel an Appointment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The Appointment that was cancelled.

mutation CancelOnSiteJobsAppointment($input: CancelOnSiteJobsAppointmentInputType!) {
  cancelOnSiteJobsAppointment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

{
  "input": CancelOnSiteJobsAppointmentInputType
}

{
  "data": {
    "cancelOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

cancelPayment

Type:CancelPayment

Cancel an in-flight payment.

The possible errors that can be raised are:

KT-CT-3924: Unauthorized.
KT-CT-3954: Payment cancellation failed.
KT-CT-3955: Payment cannot be cancelled.
KT-CT-3956: Temporary error occurred.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelPaymentInput!)

Input fields for cancelling a pending payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (AccountPaymentType)

The cancelled payment.

mutation CancelPayment($input: CancelPaymentInput!) {
  cancelPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": CancelPaymentInput
}

{
  "data": {
    "cancelPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

cancelRepaymentRequest

Type:CancelRepaymentRequest

Cancel a repayment or refund request.

The possible errors that can be raised are:

KT-CT-4231: Unauthorized.
KT-CT-3930: The repayment or refund request does not exist.
KT-CT-3931: This repayment or refund request cannot be cancelled.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (CancelRepaymentRequestInputType!)

Input fields for cancelling a repayment request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentRequest (CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
  cancelRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...CancelRepaymentRequestOutputTypeFragment
    }
  }
}

{
  "input": CancelRepaymentRequestInputType
}

{
  "data": {
    "cancelRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": CancelRepaymentRequestOutputType
    }
  }
}

cancelSiteworksAppointment

Type:CancelSiteworksAppointment

Cancel a Siteworks appointment.

Deprecated

The 'cancelSiteworksAppointment' field is deprecated.

Please use cancelOnSiteJobsAppointment instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Arguments

Name Description

input (CancelSiteworksAppointmentInput!)

Input fields for cancelling a siteworks appointment.

Return fields

Name Description

siteworksAppointment (ActiveAppointmentType)

mutation CancelSiteworksAppointment($input: CancelSiteworksAppointmentInput!) {
  cancelSiteworksAppointment(input: $input) {
    siteworksAppointment {
      ...ActiveAppointmentTypeFragment
    }
  }
}

{
  "input": CancelSiteworksAppointmentInput
}

{
  "data": {
    "cancelSiteworksAppointment": {
      "siteworksAppointment": ActiveAppointmentType
    }
  }
}

cancelSmartFlexOnboarding

Type:CancelSmartFlexOnboarding

Cancel onboarding of a device with SmartFlex.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CancelSmartFlexOnboardingInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation CancelSmartFlexOnboarding($input: CancelSmartFlexOnboardingInput!) {
  cancelSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CancelSmartFlexOnboardingInput
}

{
  "data": {
    "cancelSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

checkBusinessCreditRisk

Type:CheckBusinessCreditRisk

Create and retrieve a business credit risk analysis using a creditscore for LTDs.

Arguments

Name Description

checkBusinessCreditRiskInput (CheckBusinessCreditRiskInput!)

Input for checking business credit risk.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentMultiplier (Int)

PaymentMultiplier to determine deposit amount.

mutation CheckBusinessCreditRisk($checkBusinessCreditRiskInput: CheckBusinessCreditRiskInput!) {
  checkBusinessCreditRisk(checkBusinessCreditRiskInput: $checkBusinessCreditRiskInput) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentMultiplier
  }
}

{
  "checkBusinessCreditRiskInput": CheckBusinessCreditRiskInput
}

{
  "data": {
    "checkBusinessCreditRisk": {
      "possibleErrors": [PossibleErrorType],
      "paymentMultiplier": 1
    }
  }
}

checkDeviceConnection

Type:CheckDeviceConnection

Triggers an asynchronous request to check the connection of a device. The request reference is returned, which can be used to track the status of the request.

Arguments

Name Description

input (CheckDeviceConnectionInput!)

Input field for checking device connection.

Return fields

Name Description

requestReference (String)

The reference of the request in Kraken.

mutation CheckDeviceConnection($input: CheckDeviceConnectionInput!) {
  checkDeviceConnection(input: $input) {
    requestReference
  }
}

{
  "input": CheckDeviceConnectionInput
}

{
  "data": {
    "checkDeviceConnection": {
      "requestReference": "abc123"
    }
  }
}

claimOctoplusReward

Type:ClaimOctoplusReward

Claim an Octoplus Reward.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.
KT-GB-9319: This feature is not currently available.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'claimOctoplusReward' field is deprecated.

The Octoplus feature is going through changes. This mutation is no longer available.

- Marked as deprecated on 2026-02-10.
- Scheduled for removal on or after 2026-08-10.

Arguments

Name Description

accountNumber (String!)

The account number for the Octoplus-enrolled account.

offerSlug (String!)

The unique string identifier for the offer to be claimed.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

rewardId (String)

The ID of the claimed reward.

mutation ClaimOctoplusReward(
  $accountNumber: String!,
  $offerSlug: String!
) {
  claimOctoplusReward(
    accountNumber: $accountNumber,
    offerSlug: $offerSlug
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    rewardId
  }
}

{
  "accountNumber": "abc123",
  "offerSlug": "abc123"
}

{
  "data": {
    "claimOctoplusReward": {
      "possibleErrors": [PossibleErrorType],
      "rewardId": "abc123"
    }
  }
}

claimShoptopusVoucher

Type:ClaimShoptopusVoucher

Claim a Shoptopus Voucher using Octopoints.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.
KT-GB-9319: This feature is not currently available.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'claimShoptopusVoucher' field is deprecated.

The Octoplus feature is going through changes. This mutation is no longer available.

- Marked as deprecated on 2026-02-10.
- Scheduled for removal on or after 2026-08-10.

Arguments

Name Description

accountNumber (String!)

The account number for the Octoplus-enrolled account.

points (Int!)

The number of Octopoints to exchange for a reward.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

code (String)

The Reward Voucher code.

mutation ClaimShoptopusVoucher(
  $accountNumber: String!,
  $points: Int!
) {
  claimShoptopusVoucher(
    accountNumber: $accountNumber,
    points: $points
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    code
  }
}

{
  "accountNumber": "abc123",
  "points": 1
}

{
  "data": {
    "claimShoptopusVoucher": {
      "possibleErrors": [PossibleErrorType],
      "code": "abc123"
    }
  }
}

closeDcaProceeding

Type:CloseDCAProceeding

Close the DCA proceeding for an account.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-11602: Could not find DCA with that name.
KT-CT-11603: Could not stop debt collection proceeding.
KT-CT-11604: Active debt collection proceeding does not exist for account.
KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CloseDCAProceedingInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

dcaProceedingClosureStatus (DCAProceedingClosureStatus)

Whether the closure could be applied.

mutation CloseDcaProceeding($input: CloseDCAProceedingInputType!) {
  closeDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingClosureStatus {
      ...DCAProceedingClosureStatusFragment
    }
  }
}

{
  "input": CloseDCAProceedingInputType
}

{
  "data": {
    "closeDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingClosureStatus": DCAProceedingClosureStatus
    }
  }
}

closeInkConversation

Type:CloseInkConversation

The possible errors that can be raised are:

KT-CT-7612: The Ink conversation was not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CloseInkConversationInput)

Input for closing an Ink conversation.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

conversation (InkConversation)

The conversation that was closed.

mutation CloseInkConversation($input: CloseInkConversationInput) {
  closeInkConversation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    conversation {
      ...InkConversationFragment
    }
  }
}

{
  "input": CloseInkConversationInput
}

{
  "data": {
    "closeInkConversation": {
      "possibleErrors": [PossibleErrorType],
      "conversation": InkConversation
    }
  }
}

closeInkLiveChat

Type:CloseInkLiveChatConversation

The possible errors that can be raised are:

KT-CT-7616: Not yet implemented.
KT-CT-7643: The Live Chat was not found.
KT-CT-7644: Ink Live Chat conversation not found.
KT-CT-7652: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CloseInkLiveChaConversationtInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

mutation CloseInkLiveChat($input: CloseInkLiveChaConversationtInput) {
  closeInkLiveChat(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    liveChatConversation {
      ...InkLiveChatConversationFragment
    }
  }
}

{
  "input": CloseInkLiveChaConversationtInput
}

{
  "data": {
    "closeInkLiveChat": {
      "possibleErrors": [PossibleErrorType],
      "liveChatConversation": InkLiveChatConversation
    }
  }
}

closeOpenPrintBatch

Type:CloseOpenPrintBatch!

Close the Open Print Batch if any.

The possible errors that can be raised are:

KT-CT-9010: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Return fields

Name	Description

mutation CloseOpenPrintBatch {
  closeOpenPrintBatch {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    printBatch {
      ...PrintBatchTypeFragment
    }
  }
}

{
  "data": {
    "closeOpenPrintBatch": {
      "possibleErrors": [PossibleErrorType],
      "printBatch": PrintBatchType
    }
  }
}

collectDeposit

Type:CollectDeposit

Collect deposit for the given account.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-5711: No collection is required.
KT-CT-5712: Deposit agreement does not exist or has not been accepted.
KT-CT-5713: Payment instruction is not usable.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CollectDepositInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (CollectDepositOutput)

mutation CollectDeposit($input: CollectDepositInput!) {
  collectDeposit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...CollectDepositOutputFragment
    }
  }
}

{
  "input": CollectDepositInput
}

{
  "data": {
    "collectDeposit": {
      "possibleErrors": [PossibleErrorType],
      "payment": CollectDepositOutput
    }
  }
}

collectPayment

Type:CollectPayment

Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.

The possible errors that can be raised are:

KT-CT-3932: Invalid data.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (AccountPaymentType)

Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled.

mutation CollectPayment($input: CollectPaymentInput!) {
  collectPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": CollectPaymentInput
}

{
  "data": {
    "collectPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

commenceDcaProceeding

Type:CommenceDCAProceeding

Add commencement to an account.

The possible errors that can be raised are:

KT-CT-11606: Debt Collection Agency cannot use campaign.
KT-CT-11601: Cannot start collection proceeding, proceeding for this account already exists.
KT-CT-11602: Could not find DCA with that name.
KT-CT-11607: Invalid ledger number for debt collection proceeding.
KT-CT-11608: Ledger does not belong to account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CommenceDCAProceedingInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

dcaProceedingCommencementStatus (DCAProceedingCommencementStatus)

Whether the commencement could be applied.

mutation CommenceDcaProceeding($input: CommenceDCAProceedingInputType!) {
  commenceDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingCommencementStatus {
      ...DCAProceedingCommencementStatusFragment
    }
  }
}

{
  "input": CommenceDCAProceedingInputType
}

{
  "data": {
    "commenceDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
    }
  }
}

commissionMeter

Type:CommissionMeter

Commissions the device after the meter has been physically installed.

The possible errors that can be raised are:

KT-GB-4021: Invalid MPxN.
KT-GB-4022: MPxN not recognised.
KT-GB-4023: Error sending the request to commission the device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CommissionMeterInput!)

Input fields for commission meters.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The id of the SMETS Commission Request in Kraken.

mutation CommissionMeter($input: CommissionMeterInput!) {
  commissionMeter(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": CommissionMeterInput
}

{
  "data": {
    "commissionMeter": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

completeAuthFlowForSmartFlexOnboarding

Type:CompleteAuthFlowForSmartFlexOnboarding

Complete the authentication flow to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteAuthFlowInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation CompleteAuthFlowForSmartFlexOnboarding($input: CompleteAuthFlowInput!) {
  completeAuthFlowForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteAuthFlowInput
}

{
  "data": {
    "completeAuthFlowForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeEnrollment

Type:CompleteEnrollment

Complete the enrollment of a property on the account that was missing meter point details by supplying the required meter point information.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-6622: Unauthorized.
KT-GB-4138: Unable to complete enrollment for account.
KT-GB-4139: Unable to complete enrollment.
KT-GB-4140: MPAN number is required for enrollment.
KT-GB-4141: MPRN number is required for enrollment.
KT-GB-4142: Prepay meter could not be enrolled.
KT-GB-4143: MPAN not required to complete enrollment.
KT-GB-4144: MPRN not required to complete enrollment.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteEnrollmentInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountNumber (String)

The number of the account whose enrollment was completed.

mutation CompleteEnrollment($input: CompleteEnrollmentInput) {
  completeEnrollment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
  }
}

{
  "input": CompleteEnrollmentInput
}

{
  "data": {
    "completeEnrollment": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "abc123"
    }
  }
}

completeStandalonePayment

Type:CompleteStandalonePayment

Complete a standalone payment.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3823: Unauthorized.
KT-CT-3974: Unauthorized.
KT-CT-3975: Unable to complete standalone payment.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteStandalonePaymentInput!)

Input fields for completing a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (CompleteStandalonePaymentOutput)

The completed standalone payment.

mutation CompleteStandalonePayment($input: CompleteStandalonePaymentInput!) {
  completeStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...CompleteStandalonePaymentOutputFragment
    }
  }
}

{
  "input": CompleteStandalonePaymentInput
}

{
  "data": {
    "completeStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": CompleteStandalonePaymentOutput
    }
  }
}

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type:CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

Complete the Tesla virtual key setup onboarding step.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  completeTeslaSetupVirtualKeyForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "completeTeslaSetupVirtualKeyForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserActionForSmartFlexOnboarding

Type:CompleteUserActionRequiredForSmartFlexOnboarding

Complete the user action required step to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation CompleteUserActionForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  completeUserActionForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "completeUserActionForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserInputRequiredForSmartFlexOnboarding

Type:CompleteUserInputRequiredForSmartFlexOnboarding

Complete the user input required step to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UserInputRequiredInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation CompleteUserInputRequiredForSmartFlexOnboarding($input: UserInputRequiredInput!) {
  completeUserInputRequiredForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": UserInputRequiredInput
}

{
  "data": {
    "completeUserInputRequiredForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

confirmDoubleOptIn

Type:ConfirmDoubleOptIn

Confirm a double opt in

The possible errors that can be raised are:

KT-CT-9016: Consent management not enabled.
KT-CT-9020: Invalid consent expiring token.
KT-CT-9021: Consent expiring token not found.
KT-CT-9022: Consent for given token already accepted.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ConfirmDoubleOptInInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consent (ConsentType)

The consent that was created or updated.

mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
  confirmDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

{
  "input": ConfirmDoubleOptInInput
}

{
  "data": {
    "confirmDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

confirmSiteworksAppointmentSlot

Type:ConfirmSiteworksAppointmentSlot

Confirm an appointment slot returned by the appointment slots query.

The possible errors that can be raised are:

KT-GB-4219: Property does not exist.
KT-GB-4220: No account currently active at property.
KT-GB-4221: Could not confirm duplicate property.
KT-GB-4228: Cannot currently book appointments for legacy prepay meters.
KT-GB-4229: A smart meter exchange appointment for this date already exists.
KT-GB-4210: Bookings not supported for agent appointed at property.
KT-GB-4211: Timeslot no longer available.
KT-GB-4212: Missing or invalid data for account or property.
KT-GB-4234: Booking service currently unavailable.
KT-GB-4217: Unknown agent carrying out the appointment.
KT-GB-4240: Job type entry is not enabled.
KT-GB-4239: Job type value is not supported by the agent appointed at property.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ConfirmSiteworksAppointmentSlotInput!)

Input fields for booking a siteworks appointment slot.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

siteworksAppointment (ActiveAppointmentType)

mutation ConfirmSiteworksAppointmentSlot($input: ConfirmSiteworksAppointmentSlotInput!) {
  confirmSiteworksAppointmentSlot(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    siteworksAppointment {
      ...ActiveAppointmentTypeFragment
    }
  }
}

{
  "input": ConfirmSiteworksAppointmentSlotInput
}

{
  "data": {
    "confirmSiteworksAppointmentSlot": {
      "possibleErrors": [PossibleErrorType],
      "siteworksAppointment": ActiveAppointmentType
    }
  }
}

connectAiAgentToCall

Type:ConnectAiAgentToCall

The possible errors that can be raised are:

KT-CT-11802: Call not found.
KT-CT-11815: Unable to connect a call to an AI agent.
KT-CT-11817: Invalid call ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ConnectAiAgentToCallInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

call (InboundCallType)

The call the AI agent was connected to.

mutation ConnectAiAgentToCall($input: ConnectAiAgentToCallInput!) {
  connectAiAgentToCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

{
  "input": ConnectAiAgentToCallInput
}

{
  "data": {
    "connectAiAgentToCall": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

createAccountCharge

Type:CreateAccountCharge

Add charge to an account.

The possible errors that can be raised are:

KT-CT-5211: The charge reason with the requested code is deprecated.
KT-CT-5212: The charge reason with the requested code does not exist.
KT-CT-5213: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAccountChargeInput!)

Input fields for creating an account charge.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountCharge (AccountChargeType)

mutation CreateAccountCharge($input: CreateAccountChargeInput!) {
  createAccountCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountCharge {
      ...AccountChargeTypeFragment
    }
  }
}

{
  "input": CreateAccountChargeInput
}

{
  "data": {
    "createAccountCharge": {
      "possibleErrors": [PossibleErrorType],
      "accountCharge": AccountChargeType
    }
  }
}

createAccountFileAttachment

Type:CreateAccountFileAttachmentPayload!

Arguments

Name Description

input (CreateAccountFileAttachmentInput!)

Return fields

Name	Description

mutation CreateAccountFileAttachment($input: CreateAccountFileAttachmentInput!) {
  createAccountFileAttachment(input: $input) {
    postRequest {
      ...UploadPostRequestFragment
    }
    clientMutationId
  }
}

{
  "input": CreateAccountFileAttachmentInput
}

{
  "data": {
    "createAccountFileAttachment": {
      "postRequest": UploadPostRequest,
      "clientMutationId": "abc123"
    }
  }
}

createAccountNote

Type:CreateAccountNote

Add a note to an account.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4180: Account note must be a valid string.
KT-CT-4196: Unpin at date provided is in the past.
KT-CT-4195: Unpin at date provided for an unpinned note.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAccountNoteInput!)

Input variables needed for adding a note to an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

Account, which has the added note.

mutation CreateAccountNote($input: CreateAccountNoteInput!) {
  createAccountNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": CreateAccountNoteInput
}

{
  "data": {
    "createAccountNote": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

createAccountPaymentSchedule

Type:CreateAccountPaymentSchedule

Replace an existing payment schedule with a new one that updates either the payment amount or payment day.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3815: No active payment schedule found for this account.
KT-CT-3822: Unauthorized.
KT-CT-3923: Unauthorized.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3960: Invalid value for payment day.
KT-CT-3961: Cannot update plan-associated payment schedule.
KT-CT-3962: No new value provided to update payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAccountPaymentScheduleInput!)

Input fields for updating a payment schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

schedule (PaymentScheduleType!)

New payment schedule.

mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
  createAccountPaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": CreateAccountPaymentScheduleInput
}

{
  "data": {
    "createAccountPaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

createAccountReference

Type:CreateAccountReference

Create an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReference (AccountReferenceType)

mutation CreateAccountReference($input: AccountReferenceInput!) {
  createAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "createAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

createAccountReminder

Type:CreateAccountReminder

Create an account reminder.

The possible errors that can be raised are:

KT-CT-1401: Invalid data.
KT-CT-1402: Unable to create account reminder.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createAccountReminder' field is deprecated.

This mutation rely on legacy reminder types.
Please use the createReminder mutation which uses the new registry based reminder types instead.

- Marked as deprecated on 2024-11-14.
- Scheduled for removal on or after 2025-04-16.

Arguments

Name Description

input (CreateAccountReminderInput!)

Input variables needed for creating an account reminder.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReminder (AccountReminder)

Account reminder.

mutation CreateAccountReminder($input: CreateAccountReminderInput!) {
  createAccountReminder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReminder {
      ...AccountReminderFragment
    }
  }
}

{
  "input": CreateAccountReminderInput
}

{
  "data": {
    "createAccountReminder": {
      "possibleErrors": [PossibleErrorType],
      "accountReminder": AccountReminder
    }
  }
}

createAcquisitionQuoteRequestForProducts

Type:CreateAcquisitionQuoteRequestForProducts

Create an acquisition quote request for requested products without persisting to the database.

The possible errors that can be raised are:

KT-GB-4625: Unable to create quote request.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (CreateAcquisitionQuoteRequestForProductsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (QuoteRequestBase)

Returns a quote request for the requested product codes. Does not persist the quote.

mutation CreateAcquisitionQuoteRequestForProducts($input: CreateAcquisitionQuoteRequestForProductsInput!) {
  createAcquisitionQuoteRequestForProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteRequestBaseFragment
    }
  }
}

{
  "input": CreateAcquisitionQuoteRequestForProductsInput
}

{
  "data": {
    "createAcquisitionQuoteRequestForProducts": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": QuoteRequestBase
    }
  }
}

createAffiliateLink

Type:CreateAffiliateLink!

Create an affiliate link for a new sales agent.

The possible errors that can be raised are:

KT-CT-7711: Invalid data.
KT-CT-7713: Invalid data.
KT-CT-7714: Invalid data.
KT-CT-7715: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAffiliateLinkInputType!)

Input fields for creating an affiliate link for an organisation.

Return fields

Name	Description

mutation CreateAffiliateLink($input: CreateAffiliateLinkInputType!) {
  createAffiliateLink(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

{
  "input": CreateAffiliateLinkInputType
}

{
  "data": {
    "createAffiliateLink": {
      "possibleErrors": [PossibleErrorType],
      "affiliateLink": AffiliateLinkType
    }
  }
}

createAffiliateOrganisation

Type:CreateAffiliateOrganisation!

Create an affiliate organisation.

The possible errors that can be raised are:

KT-CT-7716: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAffiliateOrganisationInputType!)

Input fields for creating an affiliate organisation.

Return fields

Name	Description

mutation CreateAffiliateOrganisation($input: CreateAffiliateOrganisationInputType!) {
  createAffiliateOrganisation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

{
  "input": CreateAffiliateOrganisationInputType
}

{
  "data": {
    "createAffiliateOrganisation": {
      "possibleErrors": [PossibleErrorType],
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

createAffiliateSession

Type:CreateAffiliateSession!

Create a session for an affiliate link.

Arguments

Name Description

input (CreateAffiliateSessionInputType!)

Input fields for creating a session for an affiliate link.

Return fields

Name	Description

mutation CreateAffiliateSession($input: CreateAffiliateSessionInputType!) {
  createAffiliateSession(input: $input) {
    affiliateSession {
      ...AffiliateSessionTypeFragment
    }
  }
}

{
  "input": CreateAffiliateSessionInputType
}

{
  "data": {
    "createAffiliateSession": {
      "affiliateSession": AffiliateSessionType
    }
  }
}

createAgreement

Type:CreateAgreement

Create a new agreement.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4719: No supply point found for identifier provided.
KT-CT-4910: No product exists with the given input.
KT-CT-1503: Agreement validto date must be later than validfrom date.
KT-CT-1509: Unable to create agreement.
KT-CT-1511: Cannot create overlapping agreement.
KT-CT-1512: Account type does not support agreements.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAgreementInput!)

Input fields for creating an agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreement (CommonAgreementType)

The created agreement.

mutation CreateAgreement($input: CreateAgreementInput!) {
  createAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

{
  "input": CreateAgreementInput
}

{
  "data": {
    "createAgreement": {
      "possibleErrors": [PossibleErrorType],
      "agreement": CommonAgreementType
    }
  }
}

createAgreementRollover

Type:CreateAgreementRollover

Create an agreement rollover for a specific account and agreement.

The possible errors that can be raised are:

KT-CT-1501: Agreement not found.
KT-CT-4910: No product exists with the given input.
KT-CT-4924: Unauthorized.
KT-CT-13701: An active agreement rollover already exists for this agreement.
KT-CT-13702: Expected send date cannot be in the past.
KT-CT-13703: Rollover date cannot be in the past.
KT-CT-13704: Unable to create agreement rollover.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAgreementRolloverInput!)

Create an agreement rollover for a specific account and agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreementRollover (AgreementRolloverType)

The new agreement rollover.

mutation CreateAgreementRollover($input: CreateAgreementRolloverInput!) {
  createAgreementRollover(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

{
  "input": CreateAgreementRolloverInput
}

{
  "data": {
    "createAgreementRollover": {
      "possibleErrors": [PossibleErrorType],
      "agreementRollover": AgreementRolloverType
    }
  }
}

createApiCall

Type:CreateAPICall

Mutation to create a new APICall instance.

The possible errors that can be raised are:

KT-CT-7803: Received an invalid apiExceptionId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAPICallInput!)

Input fields for creating an API call.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiCall (APICallType)

The created APICall.

mutation CreateApiCall($input: CreateAPICallInput!) {
  createApiCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiCall {
      ...APICallTypeFragment
    }
  }
}

{
  "input": CreateAPICallInput
}

{
  "data": {
    "createApiCall": {
      "possibleErrors": [PossibleErrorType],
      "apiCall": APICallType
    }
  }
}

createApiException

Type:CreateAPIException

Mutation to create a new APIException instance.

The possible errors that can be raised are:

KT-CT-7801: Received an invalid operationsTeamId.
KT-CT-7802: The external identifier already exists.
KT-CT-7805: Too many tags associated with this API Exception.
KT-CT-7806: Cannot create duplicate tags for the same API exception.
KT-CT-7811: Received an invalid assignedUserId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAPIExceptionInput!)

Input fields for creating an API exception.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiException (APIExceptionType)

The created APIException.

mutation CreateApiException($input: CreateAPIExceptionInput!) {
  createApiException(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

{
  "input": CreateAPIExceptionInput
}

{
  "data": {
    "createApiException": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

createApiExceptionEvent

Type:CreateAPIExceptionEvent

Mutation to create a new APIExceptionEvent instance.

The possible errors that can be raised are:

KT-CT-7803: Received an invalid apiExceptionId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAPIExceptionEventInput!)

Input fields for creating an API exception event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiExceptionEvent (APIExceptionEventType)

The created APIExceptionEvent.

mutation CreateApiExceptionEvent($input: CreateAPIExceptionEventInput!) {
  createApiExceptionEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiExceptionEvent {
      ...APIExceptionEventTypeFragment
    }
  }
}

{
  "input": CreateAPIExceptionEventInput
}

{
  "data": {
    "createApiExceptionEvent": {
      "possibleErrors": [PossibleErrorType],
      "apiExceptionEvent": APIExceptionEventType
    }
  }
}

createApiExceptionNote

Type:CreateAPIExceptionNote

Mutation to create a new APIExceptionNote instance.

The possible errors that can be raised are:

KT-CT-7803: Received an invalid apiExceptionId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiException (APIExceptionType)

The created APIExceptionNote.

mutation CreateApiExceptionNote($input: CreateAPIExceptionNoteInput!) {
  createApiExceptionNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

{
  "input": CreateAPIExceptionNoteInput
}

{
  "data": {
    "createApiExceptionNote": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

createAudioRecording

Type:CreateAudioRecording!

Create an audio recording for an affiliate session.

The possible errors that can be raised are:

KT-CT-7720: Invalid S3 key format.
KT-CT-7721: Link not found.
KT-CT-7722: Invalid input for audio recording upload.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AudioRecordingInputType!)

Input fields required to create an audio recording.

Return fields

Name	Description

mutation CreateAudioRecording($input: AudioRecordingInputType!) {
  createAudioRecording(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    audioRecording {
      ...AudioRecordingTypeFragment
    }
  }
}

{
  "input": AudioRecordingInputType
}

{
  "data": {
    "createAudioRecording": {
      "possibleErrors": [PossibleErrorType],
      "audioRecording": AudioRecordingType
    }
  }
}

createAutoTopupConfig

Type:CreateAutoTopupConfig

Create a new auto top-up config for SPAYG meter.

Arguments

Name Description

input (CreateAutoTopupConfigInput!)

Input fields for creating an auto top-up config.

Return fields

Name Description

autoTopupConfig (AutoTopupConfigType!)

The created auto top-up config.

mutation CreateAutoTopupConfig($input: CreateAutoTopupConfigInput!) {
  createAutoTopupConfig(input: $input) {
    autoTopupConfig {
      ...AutoTopupConfigTypeFragment
    }
  }
}

{
  "input": CreateAutoTopupConfigInput
}

{
  "data": {
    "createAutoTopupConfig": {
      "autoTopupConfig": AutoTopupConfigType
    }
  }
}

createBusiness

Type:CreateBusiness

Create a business.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11108: Invalid data.
KT-CT-11109: Invalid data.
KT-CT-11110: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateBusinessInput!)

Input for creating a business.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

business (BusinessType)

The created business.

mutation CreateBusiness($input: CreateBusinessInput!) {
  createBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    business {
      ...BusinessTypeFragment
    }
  }
}

{
  "input": CreateBusinessInput
}

{
  "data": {
    "createBusiness": {
      "possibleErrors": [PossibleErrorType],
      "business": BusinessType
    }
  }
}

createCallMetadata

Type:CreateCallMetadata

The possible errors that can be raised are:

KT-CT-11802: Call not found.
KT-CT-11806: Call metadata item key cannot be an empty string.
KT-CT-11807: A call metadata item with this key already exists for this call.
KT-CT-11817: Invalid call ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CallMetadataInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

call (CallInterface)

The call metadata was attached to.

mutation CreateCallMetadata($input: CallMetadataInput!) {
  createCallMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...CallInterfaceFragment
    }
  }
}

{
  "input": CallMetadataInput
}

{
  "data": {
    "createCallMetadata": {
      "possibleErrors": [PossibleErrorType],
      "call": CallInterface
    }
  }
}

createCampaignItems

Type:CreateCampaignItems

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-11501: Voice campaign not found.
KT-CT-11503: One or more campaign items are invalid and cannot be created.
KT-CT-11504: The batch of campaign items is too large.
KT-CT-11506: Invalid campaign ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateCampaignItemsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignItems ([VoiceCampaignItemType])

batchIdentifier (String)

The identifier for this batch of items to assist in tracking and logging.

mutation CreateCampaignItems($input: CreateCampaignItemsInput!) {
  createCampaignItems(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignItems {
      ...VoiceCampaignItemTypeFragment
    }
    batchIdentifier
  }
}

{
  "input": CreateCampaignItemsInput
}

{
  "data": {
    "createCampaignItems": {
      "possibleErrors": [PossibleErrorType],
      "campaignItems": [VoiceCampaignItemType],
      "batchIdentifier": "abc123"
    }
  }
}

createCollectionProcessEvent

Type:CreateCollectionProcessEvent

Create an event for a collection process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-1605: Invalid input.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateCollectionProcessEventInputType!)

Input variables needed for creating a collection process event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessEvent (CollectionProcessEventOutputType)

The created collection process event.

mutation CreateCollectionProcessEvent($input: CreateCollectionProcessEventInputType!) {
  createCollectionProcessEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessEvent {
      ...CollectionProcessEventOutputTypeFragment
    }
  }
}

{
  "input": CreateCollectionProcessEventInputType
}

{
  "data": {
    "createCollectionProcessEvent": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessEvent": CollectionProcessEventOutputType
    }
  }
}

createComplaint

Type:CreateComplaint

Create a complaint.

The possible errors that can be raised are:

KT-CT-10801: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

complaint (CreateComplaintInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

complaint (ComplaintType)

The complaint that has been created.

mutation CreateComplaint($complaint: CreateComplaintInputType!) {
  createComplaint(complaint: $complaint) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    complaint {
      ...ComplaintTypeFragment
    }
  }
}

{
  "complaint": CreateComplaintInputType
}

{
  "data": {
    "createComplaint": {
      "possibleErrors": [PossibleErrorType],
      "complaint": ComplaintType
    }
  }
}

createContract

Type:CreateContractOutput!

Create and actualize a new contract for an account or business.

The possible errors that can be raised are:

KT-CT-10001: Party is already under contract.
KT-CT-10006: Account not found.
KT-CT-10021: Business not found.
KT-CT-10018: The provided contract subject is invalid.
KT-CT-10019: Contract creation implies breach.
KT-CT-10020: The provided contract party payload is invalid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateContractInput!)

Return fields

Name	Description

mutation CreateContract($input: CreateContractInput!) {
  createContract(input: $input) {
    identifier
    wasCreated
  }
}

{
  "input": CreateContractInput
}

{
  "data": {
    "createContract": {
      "identifier": NonEmptyString,
      "wasCreated": true
    }
  }
}

createContributionAgreement

Type:CreateContributionAgreement

Create a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-9601: Invalid data.
KT-CT-9602: Unable to create contribution agreement.
KT-CT-9605: Contribution amount cannot be 0 or negative.
KT-CT-9606: Scheme is not accepting contributions at this time.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateContributionAgreementInput!)

Input variables needed for creating a contribution agreement on an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
  createContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": CreateContributionAgreementInput
}

{
  "data": {
    "createContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

createCreditTransferPermission

Type:CreateCreditTransferPermission

Create a credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3827: The ledger is not valid.
KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
KT-CT-3829: The credit transfer permission already exists.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateCreditTransferPermissionInput!)

Input fields to create a credit transfer permission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

validFrom (DateTime)

Datetime when the credit transfer permission is valid.

mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
  createCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validFrom
  }
}

{
  "input": CreateCreditTransferPermissionInput
}

{
  "data": {
    "createCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validFrom": "2020-01-01T00:00:00.000Z"
    }
  }
}

createCustomerFeedback

Type:CreateCustomerFeedback

Create unsubmitted customer feedback object.

The possible errors that can be raised are:

KT-CT-5516: Invalid data.
KT-CT-1111: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateCustomerFeedbackInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

customerFeedback (CustomerFeedbackType)

The created customer feedback object.

mutation CreateCustomerFeedback($input: CreateCustomerFeedbackInputType!) {
  createCustomerFeedback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

{
  "input": CreateCustomerFeedbackInputType
}

{
  "data": {
    "createCustomerFeedback": {
      "possibleErrors": [PossibleErrorType],
      "customerFeedback": CustomerFeedbackType
    }
  }
}

createDepositAgreement

Type:CreateDepositAgreement

Create a new deposit agreement for the account if it needs one.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateDepositAgreementInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

depositAgreement (CreateDepositAgreementOutput)

mutation CreateDepositAgreement($input: CreateDepositAgreementInput!) {
  createDepositAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    depositAgreement {
      ...CreateDepositAgreementOutputFragment
    }
  }
}

{
  "input": CreateDepositAgreementInput
}

{
  "data": {
    "createDepositAgreement": {
      "possibleErrors": [PossibleErrorType],
      "depositAgreement": CreateDepositAgreementOutput
    }
  }
}

createDirectDebitInstruction

Type:CreateDirectDebitInstruction

Create new direct debit instruction

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-3940: Invalid data.
KT-CT-3923: Unauthorized.
KT-CT-3979: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

directDebitInstruction (DirectDebitInstructionType)

mutation CreateDirectDebitInstruction($input: CreateDirectDebitInstructionInput!) {
  createDirectDebitInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    directDebitInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": CreateDirectDebitInstructionInput
}

{
  "data": {
    "createDirectDebitInstruction": {
      "possibleErrors": [PossibleErrorType],
      "directDebitInstruction": DirectDebitInstructionType
    }
  }
}

createElectricJuiceAgreement

Type:CreateElectricJuiceAgreement

Create an Electric Juice agreement for an account.

Arguments

Name Description

input (CreateElectricJuiceAgreementInput!)

Input fields for creating an Electric Juice agreement for an account.

Return fields

Name Description

agreement (Agreement)

mutation CreateElectricJuiceAgreement($input: CreateElectricJuiceAgreementInput!) {
  createElectricJuiceAgreement(input: $input) {
    agreement {
      ...AgreementFragment
    }
  }
}

{
  "input": CreateElectricJuiceAgreementInput
}

{
  "data": {
    "createElectricJuiceAgreement": {
      "agreement": Agreement
    }
  }
}

createElectricJuiceCharge

Type:CreateElectricJuiceCharge

Add a charge for Electric Juice.

Arguments

Name Description

input (CreateElectricJuiceChargeInput!)

Input fields for creating an account charge.

Return fields

Name Description

accountCharge (AccountChargeType)

mutation CreateElectricJuiceCharge($input: CreateElectricJuiceChargeInput!) {
  createElectricJuiceCharge(input: $input) {
    accountCharge {
      ...AccountChargeTypeFragment
    }
  }
}

{
  "input": CreateElectricJuiceChargeInput
}

{
  "data": {
    "createElectricJuiceCharge": {
      "accountCharge": AccountChargeType
    }
  }
}

createElectricJuiceChargeCard

Type:CreateElectricJuiceChargeCard

Create an Electric Juice charge card for an account.

Arguments

Name Description

input (CreateElectricJuiceChargeCardInput!)

Input fields for creating an Electric Juice charge card.

Return fields

Name Description

chargeCard (ChargeCardType)

mutation CreateElectricJuiceChargeCard($input: CreateElectricJuiceChargeCardInput!) {
  createElectricJuiceChargeCard(input: $input) {
    chargeCard {
      ...ChargeCardTypeFragment
    }
  }
}

{
  "input": CreateElectricJuiceChargeCardInput
}

{
  "data": {
    "createElectricJuiceChargeCard": {
      "chargeCard": ChargeCardType
    }
  }
}

createElectricJuiceCredit

Type:CreateElectricJuiceCredit

Add a credit for Electric Juice

Arguments

Name Description

input (CreateElectricJuiceCreditInput!)

Input fields for creating an Electric Juice credit.

Return fields

Name Description

accountCredit (AccountCreditType)

mutation CreateElectricJuiceCredit($input: CreateElectricJuiceCreditInput!) {
  createElectricJuiceCredit(input: $input) {
    accountCredit {
      ...AccountCreditTypeFragment
    }
  }
}

{
  "input": CreateElectricJuiceCreditInput
}

{
  "data": {
    "createElectricJuiceCredit": {
      "accountCredit": AccountCreditType
    }
  }
}

createElectricityMeterAccumulationReading

Create an electricity meter accumulation reading with the given value for the given meter. This is intended to be used for non-communicating smart meters that need their accumulation readings forwarded to their smart data service.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-11007: Electricity meter cannot be found for the given serial number.
KT-GB-6411: Could not create electricity meter reading.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name	Description
`mpan` (`String!`)	MPAN of the meter.
`readAt` (`Date!`)	The date of the electricity meter reading.
`readingValueInKwh` (`Int!`)	The reading value in kWh.
`serialNumber` (`String!`)	Serial number of the meter.

Return fields

Name Description

readingErrors ([SerializerFieldErrorsType])

id (String)

Deprecated

The 'id' field is deprecated.

The `ID` field is depreciated.

- Marked as deprecated on 2022-10-03.
- Scheduled for removal on or after 2024-01-01.

mutation CreateElectricityMeterAccumulationReading(
  $mpan: String!,
  $readAt: Date!,
  $readingValueInKwh: Int!,
  $serialNumber: String!
) {
  createElectricityMeterAccumulationReading(
    mpan: $mpan,
    readAt: $readAt,
    readingValueInKwh: $readingValueInKwh,
    serialNumber: $serialNumber
  ) {
    readingErrors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "mpan": "abc123",
  "readAt": "2020-01-01",
  "readingValueInKwh": 1,
  "serialNumber": "abc123"
}

{
  "data": {
    "createElectricityMeterAccumulationReading": {
      "readingErrors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

createElectricityMeterReading

Create electricity meter reading(s) with the given value(s) for the given meter(s).

This field requires the Authorization header to be set.

Arguments

Name	Description
`mpan` (`String`)	MPAN of the meter.
`readAt` (`Date`)	The date of the electricity meter readings.
`readings` (`[ReadingInputType]`)	List of the provided readings.
`serialNumber` (`String`)	Serial number of the meter.

Return fields

Name Description

readingErrors ([SerializerFieldErrorsType])

id (String)

Deprecated

The 'id' field is deprecated.

The `ID` field is depreciated.

- Marked as deprecated on 2022-10-03.
- Scheduled for removal on or after 2024-01-01.

mutation CreateElectricityMeterReading(
  $mpan: String,
  $readAt: Date,
  $readings: [ReadingInputType],
  $serialNumber: String
) {
  createElectricityMeterReading(
    mpan: $mpan,
    readAt: $readAt,
    readings: $readings,
    serialNumber: $serialNumber
  ) {
    readingErrors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "mpan": "abc123",
  "readAt": "2020-01-01",
  "readings": ReadingInputType,
  "serialNumber": "abc123"
}

{
  "data": {
    "createElectricityMeterReading": {
      "readingErrors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

createElectricityMeterReadingViaIvr

Create electricity meter reading(s) with the given value(s) for the given meter(s) via IVR.

This field requires the Authorization header to be set.

Arguments

Name	Description
`mpan` (`String`)	MPAN of the meter.
`readAt` (`Date`)	The date of the electricity meter readings.
`readings` (`[ReadingInputType]`)	List of the provided readings.
`serialNumber` (`String`)	Serial number of the meter.

Return fields

Name Description

readingErrors ([SerializerFieldErrorsType])

id (String)

Deprecated

The 'id' field is deprecated.

The `ID` field is depreciated.

- Marked as deprecated on 2022-10-03.
- Scheduled for removal on or after 2024-01-01.

mutation CreateElectricityMeterReadingViaIvr(
  $mpan: String,
  $readAt: Date,
  $readings: [ReadingInputType],
  $serialNumber: String
) {
  createElectricityMeterReadingViaIvr(
    mpan: $mpan,
    readAt: $readAt,
    readings: $readings,
    serialNumber: $serialNumber
  ) {
    readingErrors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "mpan": "abc123",
  "readAt": "2020-01-01",
  "readings": ReadingInputType,
  "serialNumber": "abc123"
}

{
  "data": {
    "createElectricityMeterReadingViaIvr": {
      "readingErrors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

createEvPublicChargingAgreement

Type:CreateEvPublicChargingAgreement

Create EV public charging agreement.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-5811: Active agreement already exists.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateEvPublicChargingAgreementInput!)

Input fields for creating an agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreement (Agreement)

mutation CreateEvPublicChargingAgreement($input: CreateEvPublicChargingAgreementInput!) {
  createEvPublicChargingAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...AgreementFragment
    }
  }
}

{
  "input": CreateEvPublicChargingAgreementInput
}

{
  "data": {
    "createEvPublicChargingAgreement": {
      "possibleErrors": [PossibleErrorType],
      "agreement": Agreement
    }
  }
}

createExternalAccountEvent

Type:CreateExternalAccountEvent

Create an external account event.

The possible errors that can be raised are:

KT-CT-7123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateExternalAccountEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

event (ExternalAccountEvent)

The new event data.

mutation CreateExternalAccountEvent($input: CreateExternalAccountEventInput!) {
  createExternalAccountEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    event {
      ...ExternalAccountEventFragment
    }
  }
}

{
  "input": CreateExternalAccountEventInput
}

{
  "data": {
    "createExternalAccountEvent": {
      "possibleErrors": [PossibleErrorType],
      "event": ExternalAccountEvent
    }
  }
}

createExternalAccountUserEvent

Type:CreateExternalAccountUserEvent

Create an external account user event.

The possible errors that can be raised are:

KT-CT-7123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateExternalAccountUserEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

event (ExternalAccountUserEvent)

The new event data.

mutation CreateExternalAccountUserEvent($input: CreateExternalAccountUserEventInput!) {
  createExternalAccountUserEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    event {
      ...ExternalAccountUserEventFragment
    }
  }
}

{
  "input": CreateExternalAccountUserEventInput
}

{
  "data": {
    "createExternalAccountUserEvent": {
      "possibleErrors": [PossibleErrorType],
      "event": ExternalAccountUserEvent
    }
  }
}

createExternalMessage

Type:CreateExternalMessage

Create an external message to record communications sent by external vendors. This allows you to import messages, such as emails, sent using other tools into Kraken.

The possible errors that can be raised are:

KT-CT-14201: Vendor is empty.
KT-CT-14202: Vendor message ID is empty.
KT-CT-14203: Account number is empty.
KT-CT-14204: Message already exists.
KT-CT-14205: Unable to create the external message.
KT-CT-14206: An email body is missing.
KT-CT-14207: To email is empty.
KT-CT-14208: To email is not a valid email address.
KT-CT-14209: From email is empty.
KT-CT-14210: From email is an invalid format.
KT-CT-14211: A reply to email address is empty.
KT-CT-14212: A reply to email address is not a valid email address.
KT-CT-14213: The external messaging API is not enabled.
KT-CT-14214: An account number was provided, but no corresponding account could be found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateExternalMessageInput!)

Input variables needed for creating an external message.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

externalMessage (ExternalMessageType)

The external message that was created.

mutation CreateExternalMessage($input: CreateExternalMessageInput!) {
  createExternalMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    externalMessage {
      ...ExternalMessageTypeFragment
    }
  }
}

{
  "input": CreateExternalMessageInput
}

{
  "data": {
    "createExternalMessage": {
      "possibleErrors": [PossibleErrorType],
      "externalMessage": ExternalMessageType
    }
  }
}

createFormSubmission

Type:FormSubmissionOuput

Create a "form submission" entity. This is only meant to be used as a quick way of putting together a form and submit data for it, in the form of JSON - it is not expected that all form submissions will come through this path.

This field requires the Authorization header to be set.

Arguments

Name Description

input (FormSubmissionInput!)

Return fields

Name Description

id (Int)

content (JSONString)

errors ([SerializerFieldErrorsType])

mutation CreateFormSubmission($input: FormSubmissionInput!) {
  createFormSubmission(input: $input) {
    id
    content
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
  }
}

{
  "input": FormSubmissionInput
}

{
  "data": {
    "createFormSubmission": {
      "id": 1,
      "content": {"key": "value"},
      "errors": [SerializerFieldErrorsType]
    }
  }
}

createGasMeterReading

Create gas meter reading with the given value for the given meter.

This field requires the Authorization header to be set.

Arguments

Name	Description
`mprn` (`String`)	MPRN of the meter.
`readAt` (`Date`)	The date of the gas meter reading.
`reading` (`Int`)	Value of the provided reading.
`serialNumber` (`String`)	Serial number of the meter.

Return fields

Name Description

readingErrors ([SerializerFieldErrorsType])

id (String)

Deprecated

The 'id' field is deprecated.

The `ID` field is depreciated.

- Marked as deprecated on 2022-10-03.
- Scheduled for removal on or after 2024-01-01.

mutation CreateGasMeterReading(
  $mprn: String,
  $readAt: Date,
  $reading: Int,
  $serialNumber: String
) {
  createGasMeterReading(
    mprn: $mprn,
    readAt: $readAt,
    reading: $reading,
    serialNumber: $serialNumber
  ) {
    readingErrors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "mprn": "abc123",
  "readAt": "2020-01-01",
  "reading": 1,
  "serialNumber": "abc123"
}

{
  "data": {
    "createGasMeterReading": {
      "readingErrors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

createGasMeterReadingViaIvr

Create gas meter reading with the given value for the given meter via IVR.

This field requires the Authorization header to be set.

Arguments

Name	Description
`mprn` (`String`)	MPRN of the meter.
`readAt` (`Date`)	The date of the gas meter reading.
`reading` (`Int`)	Value of the provided reading.
`serialNumber` (`String`)	Serial number of the meter.

Return fields

Name Description

readingErrors ([SerializerFieldErrorsType])

id (String)

Deprecated

The 'id' field is deprecated.

The `ID` field is depreciated.

- Marked as deprecated on 2022-10-03.
- Scheduled for removal on or after 2024-01-01.

mutation CreateGasMeterReadingViaIvr(
  $mprn: String,
  $readAt: Date,
  $reading: Int,
  $serialNumber: String
) {
  createGasMeterReadingViaIvr(
    mprn: $mprn,
    readAt: $readAt,
    reading: $reading,
    serialNumber: $serialNumber
  ) {
    readingErrors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "mprn": "abc123",
  "readAt": "2020-01-01",
  "reading": 1,
  "serialNumber": "abc123"
}

{
  "data": {
    "createGasMeterReadingViaIvr": {
      "readingErrors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

createGoodsPurchase

Type:CreateGoodsPurchase

Create a goods purchase.

The possible errors that can be raised are:

KT-CT-8206: Invalid data.
KT-CT-1131: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsPurchase (GoodsPurchase)

Goods purchase created.

mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
  createGoodsPurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": CreatePurchaseInput
}

{
  "data": {
    "createGoodsPurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

createGoodsQuote

Type:CreateGoodsQuote

Create a goods quote.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-8205: Unable to create quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsQuote (GoodsQuote)

Goods quote created for the customer.

mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
  createGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteInput
}

{
  "data": {
    "createGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createGoodsQuoteWithoutAccount

Type:CreateGoodsQuoteWithoutAccount

Create a goods quote without an account.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateGoodsQuoteWithoutAccountInput!)

Input fields for creating a goods quote without an existing account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsQuote (GoodsQuote)

Goods quote created for the customer.

mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
  createGoodsQuoteWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

{
  "data": {
    "createGoodsQuoteWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createInboundCall

Type:CreateInboundCall

The possible errors that can be raised are:

KT-CT-11805: Invalid input for creating an inbound call.
KT-CT-11810: Caller is blocked.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateInboundCallInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

call (InboundCallType)

The call that was created.

mutation CreateInboundCall($input: CreateInboundCallInput!) {
  createInboundCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

{
  "input": CreateInboundCallInput
}

{
  "data": {
    "createInboundCall": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

createInkInboundMessage

Type:CreateInkInboundMessage

The possible errors that can be raised are:

KT-CT-7622: Attachment bucket is invalid.
KT-CT-7623: Attachment path is invalid.
KT-CT-7621: Attachment not found.
KT-CT-7618: Unable to process message.
KT-CT-7625: Invalid email address.
KT-CT-7630: Message with this message ID has already been processed.
KT-CT-7632: The text content of the Ink Inbound Generic Message is too long.
KT-CT-7620: Channel not supported.
KT-CT-7627: The 'email' object is missing from the payload.
KT-CT-7628: The 'generic' object is missing from the payload.
KT-CT-7629: The 'post' object is missing from the payload.
KT-CT-7653: Account numbers on the message and message type must match if both are supplied.
KT-CT-7654: An account number was provided, but no corresponding account could be found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateInkInboundMessageInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

message (InkMessage!)

The Ink message that was created.

mutation CreateInkInboundMessage($input: CreateInkInboundMessageInput) {
  createInkInboundMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message {
      ... on InkEmail {
        ...InkEmailFragment
      }
      ... on InkSMS {
        ...InkSMSFragment
      }
      ... on InkLine {
        ...InkLineFragment
      }
      ... on InkWhatsApp {
        ...InkWhatsAppFragment
      }
      ... on InkTwilioWhatsApp {
        ...InkTwilioWhatsAppFragment
      }
      ... on InkPost {
        ...InkPostFragment
      }
      ... on InkGenericMessage {
        ...InkGenericMessageFragment
      }
      ... on InkLiveChatMessage {
        ...InkLiveChatMessageFragment
      }
    }
  }
}

{
  "input": CreateInkInboundMessageInput
}

{
  "data": {
    "createInkInboundMessage": {
      "possibleErrors": [PossibleErrorType],
      "message": InkEmail
    }
  }
}

createInkLiveChatMessage

Type:CreateInkLiveChatMessage

The possible errors that can be raised are:

KT-CT-7616: Not yet implemented.
KT-CT-1111: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-7642: No account user was found for the given fromHandle.
KT-CT-7641: Live Chat message with this message ID has already been processed.
KT-CT-7645: The user is not authorized to access this Live Chat.
KT-CT-7622: Attachment bucket is invalid.
KT-CT-7623: Attachment path is invalid.
KT-CT-7621: Attachment not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateInkLiveChatMessageInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

messageRelayId (String!)

The ID of the Ink Live Chat message that was created.

mutation CreateInkLiveChatMessage($input: CreateInkLiveChatMessageInput) {
  createInkLiveChatMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    liveChatConversation {
      ...InkLiveChatConversationFragment
    }
    messageRelayId
  }
}

{
  "input": CreateInkLiveChatMessageInput
}

{
  "data": {
    "createInkLiveChatMessage": {
      "possibleErrors": [PossibleErrorType],
      "liveChatConversation": InkLiveChatConversation,
      "messageRelayId": "abc123"
    }
  }
}

createInternalCompany

Type:CreateInternalCompany

Create a new internal company.

The possible errors that can be raised are:

KT-CT-14402: Duplicated internal company.
KT-CT-14403: Invalid address.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateInternalCompanyInput!)

The input required to create an internal company.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

internalCompany (CreateInternalCompanyResultType)

The result of the create internal company operation.

mutation CreateInternalCompany($input: CreateInternalCompanyInput!) {
  createInternalCompany(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    internalCompany {
      ...CreateInternalCompanyResultTypeFragment
    }
  }
}

{
  "input": CreateInternalCompanyInput
}

{
  "data": {
    "createInternalCompany": {
      "possibleErrors": [PossibleErrorType],
      "internalCompany": CreateInternalCompanyResultType
    }
  }
}

createLead

Type:CreateLead

Create a lead with the provided details.

The possible errors that can be raised are:

KT-CT-8912: Funnel not found.
KT-CT-8930: Unable to parse address.
KT-CT-8928: The funnel is not active and cannot be used to create this entity.
KT-CT-8931: Extra detail value is invalid.
KT-CT-8919: Funnel initial stage not set.
KT-CT-9017: Consent type not found.
KT-CT-8932: Lead contact details missing legal contact.
KT-CT-8934: Lead contact details missing communications contact.
KT-CT-8935: National ID bad input.
KT-CT-4121: Invalid phone number.
KT-CT-8913: Organisation is not valid to be assigned.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateLeadInput!)

Input fields for creating a lead.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

leadNumber (String)

The unique number of the lead.

mutation CreateLead($input: CreateLeadInput!) {
  createLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    leadNumber
  }
}

{
  "input": CreateLeadInput
}

{
  "data": {
    "createLead": {
      "possibleErrors": [PossibleErrorType],
      "leadNumber": "abc123"
    }
  }
}

createMetadata

Type:CreateMetadata

Create metadata on an object.

The possible errors that can be raised are:

KT-CT-8412: Invalid data.
KT-CT-8414: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MetadataInput!)

Input fields for creating metadata.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

metadata (Metadata)

mutation CreateMetadata($input: MetadataInput!) {
  createMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": MetadataInput
}

{
  "data": {
    "createMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

createMfaDevice

Type:CreateMfaDevice

Create MFA Device for user.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-1151: MFA device not found.
KT-CT-1153: Unable to create MFA device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateMfaDeviceInputType!)

Input fields for creating a new multi-factor authentication device for the logged user.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`deviceEmail` (`String`)	Email address to send the MFA code by default.
`devicePhone` (`String`)	Phone number to send the MFA code by default.
`totpSecret` (`String`)	Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually.

mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
  createMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceEmail
    devicePhone
    totpSecret
  }
}

{
  "input": CreateMfaDeviceInputType
}

{
  "data": {
    "createMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceEmail": "abc123",
      "devicePhone": "abc123",
      "totpSecret": "abc123"
    }
  }
}

createNewAgreementFromProductSwitchProcess

Type:CreateNewAgreementFromProductSwitchProcess

Create a new agreement from an existing product switch process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4924: Unauthorized.
KT-CT-1509: Unable to create agreement.
KT-CT-1507: Agreement product switch date is not within the acceptable range.
KT-CT-1510: Product switch process not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateNewAgreementFromProductSwitchProcessInput!)

Validate the product switch flow data and creates a ProcessSwitchProcess model.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreement (CommonAgreementType)

The new agreement created.

mutation CreateNewAgreementFromProductSwitchProcess($input: CreateNewAgreementFromProductSwitchProcessInput!) {
  createNewAgreementFromProductSwitchProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

{
  "input": CreateNewAgreementFromProductSwitchProcessInput
}

{
  "data": {
    "createNewAgreementFromProductSwitchProcess": {
      "possibleErrors": [PossibleErrorType],
      "agreement": CommonAgreementType
    }
  }
}

createOctoplusRewardContactLink

Type:CreateOctoplusRewardContactLink

Create a link to the customer contact form for this account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.
KT-GB-9319: This feature is not currently available.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createOctoplusRewardContactLink' field is deprecated.

The Octoplus feature is going through changes. This mutation is no longer available.

- Marked as deprecated on 2026-02-10.
- Scheduled for removal on or after 2026-08-10.

Arguments

Name Description

accountNumber (String!)

The account number for the Octoplus-enrolled account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

url (String)

The URL of the customer contact form link.

mutation CreateOctoplusRewardContactLink($accountNumber: String!) {
  createOctoplusRewardContactLink(accountNumber: $accountNumber) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    url
  }
}

{
  "accountNumber": "abc123"
}

{
  "data": {
    "createOctoplusRewardContactLink": {
      "possibleErrors": [PossibleErrorType],
      "url": "abc123"
    }
  }
}

createOfferGroupForQuoting

Type:CreateOfferGroupForQuoting

Create a quoting Offer Group.

The possible errors that can be raised are:

KT-CT-12401: Unable to create offer group.
KT-CT-12405: Missing rates for quoting.
KT-CT-12406: Product not configured correctly for quoting.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOfferGroupForQuotingInput!)

Input fields for creating an offer group from a list of offers.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

offerGroup (CreateOfferGroupType)

Quoting Offer Group.

mutation CreateOfferGroupForQuoting($input: CreateOfferGroupForQuotingInput!) {
  createOfferGroupForQuoting(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    offerGroup {
      ...CreateOfferGroupTypeFragment
    }
  }
}

{
  "input": CreateOfferGroupForQuotingInput
}

{
  "data": {
    "createOfferGroupForQuoting": {
      "possibleErrors": [PossibleErrorType],
      "offerGroup": CreateOfferGroupType
    }
  }
}

createOnSiteJobsAppointment

Type:CreateOnSiteJobsAppointment

Create an Appointment.

The possible errors that can be raised are:

KT-CT-13030: Booking session not found.
KT-CT-13025: Booking session has expired.
KT-CT-13033: Slot not found.
KT-CT-13028: Agent not found.
KT-CT-13019: Vendor not found.
KT-CT-13034: Appointment already exists for this request.
KT-CT-13035: Request is inactive.
KT-CT-13032: Request does not exist.
KT-CT-13036: Booking service currently unavailable.
KT-CT-13037: Appointment reference not provided by booking service.
KT-CT-13031: Timeslot is no longer available.
KT-CT-13027: Booking system error occurred.
KT-CT-13056: Appointment cannot be rescheduled.
KT-CT-13044: Failed to update appointment slot.
KT-CT-13001: Appointment does not exist.
KT-CT-13063: Failed to derive property for the given supply points.
KT-CT-13006: No properties found for the given supply points.
KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

appointmentBookingSessionId (UUID!)

The appointment booking session ID to create an appointment.

slotId (UUID!)

The slot ID to book the appointment for.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

mutation CreateOnSiteJobsAppointment(
  $appointmentBookingSessionId: UUID!,
  $slotId: UUID!
) {
  createOnSiteJobsAppointment(
    appointmentBookingSessionId: $appointmentBookingSessionId,
    slotId: $slotId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

{
  "appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "slotId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

{
  "data": {
    "createOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsAppointmentWithDate

Type:CreateOnSiteJobsAppointmentWithDate

Create an Appointment using DATE booking mode. Used when the booking flow does not require selecting a specific timeslot.

The possible errors that can be raised are:

KT-CT-13032: Request does not exist.
KT-CT-13010: No booking adapter found for agent.
KT-CT-13020: Could not identify agent from property.
KT-CT-13021: Invalid job type.
KT-CT-13022: Work category not found for job type.
KT-CT-13057: Date booking mode is not applicable for this request.
KT-CT-13023: Appointment booking checks failed.
KT-CT-13024: Appointment booking checks returned warnings.
KT-CT-13028: Agent not found.
KT-CT-13019: Vendor not found.
KT-CT-13034: Appointment already exists for this request.
KT-CT-13035: Request is inactive.
KT-CT-13036: Booking service currently unavailable.
KT-CT-13037: Appointment reference not provided by booking service.
KT-CT-13027: Booking system error occurred.
KT-CT-13063: Failed to derive property for the given supply points.
KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
KT-CT-13006: No properties found for the given supply points.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name	Description
`appointmentBookingDetails` (`OnSiteJobsAppointmentBookingDetailsInput!`)	The appointment booking details.
`deadlineDate` (`Date`)	The deadline date for the appointment.
`overrideAppointmentCheckWarnings` (`Boolean`)	Whether to override appointment booking check warnings. Defaults to False.
`preferredDate` (`Date!`)	The preferred date for the appointment.
`requestId` (`UUID!`)	The ID of the request to book an appointment for.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

mutation CreateOnSiteJobsAppointmentWithDate(
  $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
  $deadlineDate: Date,
  $overrideAppointmentCheckWarnings: Boolean,
  $preferredDate: Date!,
  $requestId: UUID!
) {
  createOnSiteJobsAppointmentWithDate(
    appointmentBookingDetails: $appointmentBookingDetails,
    deadlineDate: $deadlineDate,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
    preferredDate: $preferredDate,
    requestId: $requestId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "deadlineDate": "2020-01-01",
  "overrideAppointmentCheckWarnings": true,
  "preferredDate": "2020-01-01",
  "requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

{
  "data": {
    "createOnSiteJobsAppointmentWithDate": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsAppointmentWithoutBooking

Type:CreateOnSiteJobsAppointmentWithoutBooking

Create an Appointment on Kraken without making a booking via the booking vendor system. This is typically used by booking vendors to inform Kraken about appointments created on their system.

The possible errors that can be raised are:

KT-CT-13032: Request does not exist.
KT-CT-13035: Request is inactive.
KT-CT-13010: No booking adapter found for agent.
KT-CT-13034: Appointment already exists for this request.
KT-CT-13021: Invalid job type.
KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
KT-CT-13039: Cancellation fields require CANCELLED status.
KT-CT-13027: Booking system error occurred.
KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
KT-CT-13051: Supply point not found when creating assets.
KT-CT-13052: Multiple supply points found when creating assets.
KT-CT-13062: Datetime field must be timezone-aware.
KT-CT-13044: Failed to update appointment slot.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OnSiteJobsCreateAppointmentInput!)

The input objects required to create an Appointment on Kraken without making a booking.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created Appointment.

mutation CreateOnSiteJobsAppointmentWithoutBooking($input: OnSiteJobsCreateAppointmentInput!) {
  createOnSiteJobsAppointmentWithoutBooking(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

{
  "input": OnSiteJobsCreateAppointmentInput
}

{
  "data": {
    "createOnSiteJobsAppointmentWithoutBooking": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsRequest

Type:CreateOnSiteJobsRequest

Create a Request.

The possible errors that can be raised are:

KT-CT-13002: Supply point not found.
KT-CT-13003: Supply points must belong to the same account.
KT-CT-13004: No account found for the given supply points.
KT-CT-13006: No properties found for the given supply points.
KT-CT-13028: Agent not found.
KT-CT-13010: No booking adapter found for agent.
KT-CT-13007: At least one of the request checks failed.
KT-CT-13008: At least one of the request checks has warnings.
KT-CT-13009: On site jobs Request already exists.
KT-CT-13012: Viewer is not allowed to create a request.
KT-CT-13013: Reporter post init error.
KT-CT-13014: Request reason is not supported.
KT-CT-13015: Request sub_reason is not supported.
KT-CT-13041: User is not allowed to override request/appointment checks.
KT-CT-13042: Multiple supply points not supported by this booking adapter.
KT-CT-13045: Failed to update appointment assets.
KT-CT-13047: Multiple supply points found.
KT-CT-13048: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_ids.
KT-CT-13049: Neither supplypointidentifiertomarketnamemapping nor supplypointinternal_ids provided.
KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
KT-CT-13051: Supply point not found when creating assets.
KT-CT-13052: Multiple supply points found when creating assets.
KT-CT-13058: Reason approval details are required when the reason requires approval.
KT-CT-13059: Emergency approval details are required when the emergency requires approval.
KT-CT-13060: Reason approval details should not be provided when the reason does not require approval.
KT-CT-13061: Emergency approval details should not be provided when the emergency does not require approval.
KT-CT-13063: Failed to derive property for the given supply points.
KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOnSiteJobsRequestInputType!)

The input objects required to create a Request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsRequest (OnSiteJobsRequestType)

The created request.

mutation CreateOnSiteJobsRequest($input: CreateOnSiteJobsRequestInputType!) {
  createOnSiteJobsRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

{
  "input": CreateOnSiteJobsRequestInputType
}

{
  "data": {
    "createOnSiteJobsRequest": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

createOpportunityAndLead

Type:CreateOpportunityAndLead

Create an opportunity and lead with the provided details.

The possible errors that can be raised are:

KT-CT-8912: Funnel not found.
KT-CT-8919: Funnel initial stage not set.
KT-CT-8930: Unable to parse address.
KT-CT-8907: Lead not found.
KT-CT-8901: Unable to create lead.
KT-CT-8902: Unable to create lead.
KT-CT-8935: National ID bad input.
KT-CT-4121: Invalid phone number.
KT-CT-8931: Extra detail value is invalid.
KT-CT-9017: Consent type not found.
KT-CT-8913: Organisation is not valid to be assigned.
KT-CT-8936: Only one address is required to create an opportunity.
KT-CT-8937: One or more Supply Points cannot be validated.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOpportunityAndLeadInput!)

Input fields for creating an opportunity.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`opportunityNumber` (`String`)	The unique number of the opportunity.
`dateOfCreation` (`DateTime`)	The date the opportunity was created.
`stage` (`String`)	The stage of the opportunity.
`funnelCode` (`String`)	The code of the funnel.

mutation CreateOpportunityAndLead($input: CreateOpportunityAndLeadInput!) {
  createOpportunityAndLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
    dateOfCreation
    stage
    funnelCode
  }
}

{
  "input": CreateOpportunityAndLeadInput
}

{
  "data": {
    "createOpportunityAndLead": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "abc123",
      "dateOfCreation": "2020-01-01T00:00:00.000Z",
      "stage": "abc123",
      "funnelCode": "abc123"
    }
  }
}

createOpportunityFileAttachment

Type:CreateOpportunityFileAttachment

Creates an Opportunity File Attachment.

Arguments

Name Description

input (CreateOpportunityFileAttachmentInput!)

Input to create an Opportunity File Attachment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

result (String)

Whether the operation was successful.

mutation CreateOpportunityFileAttachment($input: CreateOpportunityFileAttachmentInput!) {
  createOpportunityFileAttachment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    result
  }
}

{
  "input": CreateOpportunityFileAttachmentInput
}

{
  "data": {
    "createOpportunityFileAttachment": {
      "possibleErrors": [PossibleErrorType],
      "result": "abc123"
    }
  }
}

createOpportunityForLead

Type:CreateOpportunityForLead

Create an opportunity for a lead with the provided details.

The possible errors that can be raised are:

KT-CT-8912: Funnel not found.
KT-CT-8919: Funnel initial stage not set.
KT-CT-8907: Lead not found.
KT-CT-8913: Organisation is not valid to be assigned.
KT-CT-8924: Unable to create opportunity.
KT-CT-8925: Unable to create opportunity.
KT-CT-8926: Unable to create opportunity.
KT-CT-8928: The funnel is not active and cannot be used to create this entity.
KT-CT-8930: Unable to parse address.
KT-CT-8936: Only one address is required to create an opportunity.
KT-CT-8931: Extra detail value is invalid.
KT-CT-8937: One or more Supply Points cannot be validated.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOpportunityForLeadInput!)

Input fields for creating an opportunity for a lead.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

opportunityNumber (String)

The unique number of the opportunity.

dateOfCreation (DateTime)

The date the opportunity was created.

mutation CreateOpportunityForLead($input: CreateOpportunityForLeadInput!) {
  createOpportunityForLead(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
    dateOfCreation
  }
}

{
  "input": CreateOpportunityForLeadInput
}

{
  "data": {
    "createOpportunityForLead": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "abc123",
      "dateOfCreation": "2020-01-01T00:00:00.000Z"
    }
  }
}

createOrUpdateLoyaltyCard

Type:CreateOrUpdateLoyaltyCardMutation

Create or update a loyalty card for the given account user.

The possible errors that can be raised are:

KT-CT-5412: No account user exists with the given id.
KT-CT-8610: Invalid data.
KT-CT-8611: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOrUpdateLoyaltyCardInput!)

Input fields for creating or updating a loyalty card.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

loyaltyCard (LoyaltyCardType)

Created or updated loyalty card.

mutation CreateOrUpdateLoyaltyCard($input: CreateOrUpdateLoyaltyCardInput!) {
  createOrUpdateLoyaltyCard(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    loyaltyCard {
      ...LoyaltyCardTypeFragment
    }
  }
}

{
  "input": CreateOrUpdateLoyaltyCardInput
}

{
  "data": {
    "createOrUpdateLoyaltyCard": {
      "possibleErrors": [PossibleErrorType],
      "loyaltyCard": LoyaltyCardType
    }
  }
}

createOrUpdateSiteworksAppointment

Type:CreateOrUpdateSiteworksAppointment

Create or update a Siteworks appointment.

The possible errors that can be raised are:

KT-CT-1112: 'Authorization' header not provided.
KT-CT-4231: Unauthorized.
KT-GB-4230: Invalid data.
KT-GB-4224: Error processing siteworks appointment.
KT-CT-13043: Cannot update appointment as it has terminal status.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOrUpdateSiteworksAppointmentInput!)

Input fields for creating or updating siteworks appointments.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

result (CreateOrUpdateSiteworksAppointmentOutput)

mutation CreateOrUpdateSiteworksAppointment($input: CreateOrUpdateSiteworksAppointmentInput!) {
  createOrUpdateSiteworksAppointment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    result {
      ...CreateOrUpdateSiteworksAppointmentOutputFragment
    }
  }
}

{
  "input": CreateOrUpdateSiteworksAppointmentInput
}

{
  "data": {
    "createOrUpdateSiteworksAppointment": {
      "possibleErrors": [PossibleErrorType],
      "result": CreateOrUpdateSiteworksAppointmentOutput
    }
  }
}

createOrUpdateTimeSeriesEntries

Type:CreateOrUpdateTimeSeriesEntries!

Create or update time series entries.

The possible errors that can be raised are:

KT-CT-12014: Time series not found.
KT-CT-12015: Characteristics mismatch.
KT-CT-12016: Conflicting time series entries.
KT-CT-12017: Invalid time series entries period.
KT-CT-12038: Invalid time series entries granularity.
KT-CT-12040: Time series entries in use.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateOrUpdateTimeSeriesEntriesInput!)

The time series input for time series entry creation or update.

Return fields

Name	Description

mutation CreateOrUpdateTimeSeriesEntries($input: CreateOrUpdateTimeSeriesEntriesInput!) {
  createOrUpdateTimeSeriesEntries(input: $input) {
    code
    productCode
    name
    description
    unit
    periodSize
    meta
    variants {
      ...VariantProfileFragment
    }
  }
}

{
  "input": CreateOrUpdateTimeSeriesEntriesInput
}

{
  "data": {
    "createOrUpdateTimeSeriesEntries": {
      "code": "abc123",
      "productCode": "abc123",
      "name": "abc123",
      "description": "abc123",
      "unit": "abc123",
      "periodSize": "abc123",
      "meta": {"key": "value"},
      "variants": VariantProfile
    }
  }
}

createPaymentActionIntent

Type:CreatePaymentActionIntent

Create a new payment action intent.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3980: Invalid ledger identifier.
KT-CT-3981: Unauthorized.
KT-CT-3982: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreatePaymentActionIntentInput!)

Input fields for creating a payment action intent.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (ID!)

The action intent token.

mutation CreatePaymentActionIntent($input: CreatePaymentActionIntentInput!) {
  createPaymentActionIntent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

{
  "input": CreatePaymentActionIntentInput
}

{
  "data": {
    "createPaymentActionIntent": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123"
    }
  }
}

createPaymentSchedule

Type:CreatePaymentSchedule

Create a monthly payment schedule for a fixed amount.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-3917: Unable to create payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PaymentScheduleInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentSchedule (PaymentScheduleType)

mutation CreatePaymentSchedule($input: PaymentScheduleInput!) {
  createPaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": PaymentScheduleInput
}

{
  "data": {
    "createPaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "paymentSchedule": PaymentScheduleType
    }
  }
}

createPortfolio

Type:CreatePortfolio

Mutation to create a new Portfolio instance.

The possible errors that can be raised are:

KT-CT-9402: Received an invalid brandCode.
KT-CT-9401: Received an invalid operationsTeamId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreatePortfolioInput)

Input fields for creating a portfolio.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

portfolio (PortfolioType)

The created portfolio.

mutation CreatePortfolio($input: CreatePortfolioInput) {
  createPortfolio(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
  }
}

{
  "input": CreatePortfolioInput
}

{
  "data": {
    "createPortfolio": {
      "possibleErrors": [PossibleErrorType],
      "portfolio": PortfolioType
    }
  }
}

createPortfolioUserRole

Type:CreatePortfolioUserRole

Mutation to create a new portfolio user role. This will effectively link the user to the portfolio giving them all the permissions enabled for the specific role.

The possible errors that can be raised are:

KT-CT-9403: Received an invalid portfolioId.
KT-CT-9404: Received an invalid accountUserId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreatePortfolioUserRoleInput)

Input fields for connecting a user to a portfolio.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

portfolioUserRole (PortfolioUserRoleType)

The created role for a user in association with a portfolio.

mutation CreatePortfolioUserRole($input: CreatePortfolioUserRoleInput) {
  createPortfolioUserRole(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    portfolioUserRole {
      ...PortfolioUserRoleTypeFragment
    }
  }
}

{
  "input": CreatePortfolioUserRoleInput
}

{
  "data": {
    "createPortfolioUserRole": {
      "possibleErrors": [PossibleErrorType],
      "portfolioUserRole": PortfolioUserRoleType
    }
  }
}

createPostEvents

Type:CreatePostEvents

Create post delivery events from external vendors.

The possible errors that can be raised are:

KT-CT-9907: Post events batch size exceeded.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreatePostEventsInput!)

Batch of post events to create.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

createdEventsCount (Int)

Number of events successfully created.

mutation CreatePostEvents($input: CreatePostEventsInput!) {
  createPostEvents(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    createdEventsCount
  }
}

{
  "input": CreatePostEventsInput
}

{
  "data": {
    "createPostEvents": {
      "possibleErrors": [PossibleErrorType],
      "createdEventsCount": 1
    }
  }
}

createProduct

Type:CreateProductOutput!

Create a new product.

The possible errors that can be raised are:

KT-CT-12003: Specified product brand does not exist.
KT-CT-12004: Invalid product tag type.
KT-CT-12005: A selection of a terms and conditions type does not exist.
KT-CT-12006: Provided product characteristic overrides are not in the correct format.
KT-CT-12007: Unable to create product.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateProductInput!)

Return fields

Name	Description

mutation CreateProduct($input: CreateProductInput!) {
  createProduct(input: $input) {
    product {
      ...SupplyProductTypeFragment
    }
  }
}

{
  "input": CreateProductInput
}

{
  "data": {
    "createProduct": {
      "product": SupplyProductType
    }
  }
}

createProductRates

Type:CreateProductRates

Create product rate(s) for a certain product.

The possible errors that can be raised are:

KT-GB-9514: No available product found.
KT-GB-9518: Invalid input data for product rate(s).
KT-GB-9519: Unable to create product rate(s).
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateProductRatesInputType!)

List of rates to be created for the specified product.

productCode (String!)

Code of the product for which the rates are being created.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

productRates ([ProductRateType])

Successfully created rate(s) for the specified product.

mutation CreateProductRates(
  $input: CreateProductRatesInputType!,
  $productCode: String!
) {
  createProductRates(
    input: $input,
    productCode: $productCode
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    productRates {
      ...ProductRateTypeFragment
    }
  }
}

{
  "input": CreateProductRatesInputType,
  "productCode": "abc123"
}

{
  "data": {
    "createProductRates": {
      "possibleErrors": [PossibleErrorType],
      "productRates": [ProductRateType]
    }
  }
}

createQuote

Type:CreateQuoteOutputType

Create a quote for the given set of meter points for the supplied consumption.

Arguments

Name Description

input (CreateQuoteInput!)

Return fields

Name Description

errors ([SerializerFieldErrorsType])

quote (QuoteType)

mutation CreateQuote($input: CreateQuoteInput!) {
  createQuote(input: $input) {
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
    quote {
      ...QuoteTypeFragment
    }
  }
}

{
  "input": CreateQuoteInput
}

{
  "data": {
    "createQuote": {
      "errors": [SerializerFieldErrorsType],
      "quote": QuoteType
    }
  }
}

createQuoteForAccount

Type:CreateQuoteForAccount

Create a quote for switching product.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.
KT-CT-4616: Unable to create a quote.
KT-CT-4631: Unable to quote for the chosen market.
KT-CT-4645: No supply point found belonging to the account for the provided identifier.
KT-CT-4924: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateQuoteForAccountInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (MarketSupplyQuoteRequestType)

Returns a quote request.

mutation CreateQuoteForAccount($input: CreateQuoteForAccountInput!) {
  createQuoteForAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...MarketSupplyQuoteRequestTypeFragment
    }
  }
}

{
  "input": CreateQuoteForAccountInput
}

{
  "data": {
    "createQuoteForAccount": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": MarketSupplyQuoteRequestType
    }
  }
}

createQuoteRequestForProducts

Type:CreateQuoteRequestForProducts

Create a renewal quote request for specified products without persisting to the database.

The possible errors that can be raised are:

KT-GB-4624: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateQuoteRequestForProductsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (QuoteRequestBase)

Returns a quote request for the requested product codes. Does not persist the quote.

mutation CreateQuoteRequestForProducts($input: CreateQuoteRequestForProductsInput!) {
  createQuoteRequestForProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteRequestBaseFragment
    }
  }
}

{
  "input": CreateQuoteRequestForProductsInput
}

{
  "data": {
    "createQuoteRequestForProducts": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": QuoteRequestBase
    }
  }
}

createReferral

Type:CreateReferral

Create an account referral using an email address, personal link or code.This is for customers to refer other customers so it only works with friend referrals and not partner referrals.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6710: Unable to create referral.
KT-CT-6711: Accounts may not self-refer.
KT-CT-6713: Referring and referred account brands do not match.
KT-CT-6712: Invalid reference.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateReferralInput!)

Input fields for creating a referral.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

referredAccountRewardAmount (Int)

The reward amount to be issued to the referred account, in smallest currency subunits.

mutation CreateReferral($input: CreateReferralInput!) {
  createReferral(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    referredAccountRewardAmount
  }
}

{
  "input": CreateReferralInput
}

{
  "data": {
    "createReferral": {
      "possibleErrors": [PossibleErrorType],
      "referredAccountRewardAmount": 1
    }
  }
}

createRefundRequest

Type:CreateRefundRequest

Add a refund request to an account.

The possible errors that can be raised are:

KT-GB-4127: Unable to send refund request confirmation email.
KT-GB-4121: Unable to process refund request.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RefundRequestInput!)

Input fields for creating a refund request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

refundRequest (RefundRequestType)

mutation CreateRefundRequest($input: RefundRequestInput!) {
  createRefundRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    refundRequest {
      ...RefundRequestTypeFragment
    }
  }
}

{
  "input": RefundRequestInput
}

{
  "data": {
    "createRefundRequest": {
      "possibleErrors": [PossibleErrorType],
      "refundRequest": RefundRequestType
    }
  }
}

createReminder

Type:CreateReminder

Create an account reminder.

The possible errors that can be raised are:

KT-CT-1401: Invalid data.
KT-CT-1402: Unable to create account reminder.
KT-CT-1403: Missing user or team assignee.
KT-CT-1404: This reminder type is deprecated.
KT-CT-1405: Both user and team assignee provided.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateReminderInput!)

Input variables needed for creating an account reminder.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

reminder (Reminder)

Account reminder.

mutation CreateReminder($input: CreateReminderInput!) {
  createReminder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    reminder {
      ...ReminderFragment
    }
  }
}

{
  "input": CreateReminderInput
}

{
  "data": {
    "createReminder": {
      "possibleErrors": [PossibleErrorType],
      "reminder": Reminder
    }
  }
}

createRenewalQuoteRequest

Type:CreateRenewalQuoteRequest

Create a renewal quote request.

Arguments

Name Description

input (CreateRenewalQuoteRequestInput!)

Return fields

Name Description

quoteRequest (QuoteRequest)

mutation CreateRenewalQuoteRequest($input: CreateRenewalQuoteRequestInput!) {
  createRenewalQuoteRequest(input: $input) {
    quoteRequest {
      ...QuoteRequestFragment
    }
  }
}

{
  "input": CreateRenewalQuoteRequestInput
}

{
  "data": {
    "createRenewalQuoteRequest": {
      "quoteRequest": QuoteRequest
    }
  }
}

createScheduledTransactions

Type:CreateScheduledTransactions

Create scheduled transactions.

The possible errors that can be raised are:

KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3830: Invalid action.
KT-CT-3831: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input ([CreateScheduledTransactionsInput]!)

Input fields to create scheduled transactions.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

scheduledTransactions ([ScheduledTransactionType])

mutation CreateScheduledTransactions($input: [CreateScheduledTransactionsInput]!) {
  createScheduledTransactions(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    scheduledTransactions {
      ...ScheduledTransactionTypeFragment
    }
  }
}

{
  "input": CreateScheduledTransactionsInput
}

{
  "data": {
    "createScheduledTransactions": {
      "possibleErrors": [PossibleErrorType],
      "scheduledTransactions": [ScheduledTransactionType]
    }
  }
}

createShellAccount

Type:CreateShellAccountPayload

Create a shell/payment account.

Arguments

Name Description

input (CreateShellAccountInput!)

Return fields

Name	Description
`portfolioNumber` (`String`)
`givenName` (`String!`)
`familyName` (`String!`)
`billingName` (`String`)
`email` (`String!`)
`mobile` (`String`)
`landline` (`String`)
`brand` (`String`)
`dateOfBirth` (`Date`)
`billingAddressLine1` (`String`)
`billingAddressLine2` (`String`)
`billingAddressLine3` (`String`)
`billingAddressLine4` (`String`)
`billingAddressLine5` (`String`)
`billingPostcode` (`String`)
`billingRichAddress` (`String`)	This must be a string-ified version of the JSON representation of RichAddressInput type.
`billingPeriodLength` (`String`)	For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY.
`billingPeriodMultiplier` (`Int`)	For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing.
`billingPeriodDay` (`Int`)	Day to fixed bill on if billingperiodlength set.
`billingPeriodMonth` (`Int`)	Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1.
`isBusinessAccount` (`Boolean`)
`companyName` (`String`)
`companyNumber` (`String`)
`businessType` (`String`)
`password` (`String`)
`passwordUpdateToken` (`String`)
`urn` (`String`)
`errors` (`[ErrorType]`)
`account` (`AccountInterface`)
`clientMutationId` (`String`)

mutation CreateShellAccount($input: CreateShellAccountInput!) {
  createShellAccount(input: $input) {
    portfolioNumber
    givenName
    familyName
    billingName
    email
    mobile
    landline
    brand
    dateOfBirth
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingPostcode
    billingRichAddress
    billingPeriodLength
    billingPeriodMultiplier
    billingPeriodDay
    billingPeriodMonth
    isBusinessAccount
    companyName
    companyNumber
    businessType
    password
    passwordUpdateToken
    urn
    errors {
      ...ErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
    clientMutationId
  }
}

{
  "input": CreateShellAccountInput
}

{
  "data": {
    "createShellAccount": {
      "portfolioNumber": "abc123",
      "givenName": "abc123",
      "familyName": "abc123",
      "billingName": "abc123",
      "email": "abc123",
      "mobile": "abc123",
      "landline": "abc123",
      "brand": "abc123",
      "dateOfBirth": "2020-01-01",
      "billingAddressLine1": "abc123",
      "billingAddressLine2": "abc123",
      "billingAddressLine3": "abc123",
      "billingAddressLine4": "abc123",
      "billingAddressLine5": "abc123",
      "billingPostcode": "abc123",
      "billingRichAddress": "abc123",
      "billingPeriodLength": "abc123",
      "billingPeriodMultiplier": 1,
      "billingPeriodDay": 1,
      "billingPeriodMonth": 1,
      "isBusinessAccount": true,
      "companyName": "abc123",
      "companyNumber": "abc123",
      "businessType": "abc123",
      "password": "abc123",
      "passwordUpdateToken": "abc123",
      "urn": "abc123",
      "errors": [ErrorType],
      "account": AccountInterface,
      "clientMutationId": "abc123"
    }
  }
}

createSupplyPointMetadata

Type:CreateSupplyPointMetadata

Create metadata for a supply point.

The possible errors that can be raised are:

KT-CT-8412: Invalid data.
KT-CT-8414: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SupplyPointMetadataInput!)

Input fields for creating metadata.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

metadata (Metadata)

The created metadata.

mutation CreateSupplyPointMetadata($input: SupplyPointMetadataInput!) {
  createSupplyPointMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": SupplyPointMetadataInput
}

{
  "data": {
    "createSupplyPointMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

createTempProvisioningClaim

Type:CreateProvisioningClaim

Create a temporary provisioning cert in krakenflex

Return fields

Name Description

tempProvisioningClaimCert (GenericScalar)

The temporary provisioning certification.

mutation CreateTempProvisioningClaim {
  createTempProvisioningClaim {
    tempProvisioningClaimCert
  }
}

{
  "data": {
    "createTempProvisioningClaim": {
      "tempProvisioningClaimCert": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
    }
  }
}

createTimeSeriesPrices

Type:CreateTimeSeriesPrices!

Create time series prices.

The possible errors that can be raised are:

KT-CT-12014: Time series not found.
KT-CT-12015: Characteristics mismatch.
KT-CT-12016: Conflicting time series entries.
KT-CT-12017: Invalid time series entries period.
KT-CT-12038: Invalid time series entries granularity.
KT-CT-12040: Time series entries in use.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'createTimeSeriesPrices' field is deprecated.

Please use the 'createOrUpdateTimeSeriesEntries' mutation instead.

- Marked as deprecated on 2025-02-03.
- Scheduled for removal on or after 2025-03-01.

Arguments

Name Description

input (CreateTimeSeriesPricesInput!)

The time series input for price creation.

Return fields

Name	Description

mutation CreateTimeSeriesPrices($input: CreateTimeSeriesPricesInput!) {
  createTimeSeriesPrices(input: $input) {
    code
    productCode
    name
    description
    unit
    periodSize
    meta
    variants {
      ...VariantProfileFragment
    }
  }
}

{
  "input": CreateTimeSeriesPricesInput
}

{
  "data": {
    "createTimeSeriesPrices": {
      "code": "abc123",
      "productCode": "abc123",
      "name": "abc123",
      "description": "abc123",
      "unit": "abc123",
      "periodSize": "abc123",
      "meta": {"key": "value"},
      "variants": VariantProfile
    }
  }
}

createWarmHomeDiscountApplication

Type:WarmHomeDiscountApplicationOutputType

Create warm home discount application with given qualifying requirements and account.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-14001: The Warm Home Discount application process is closed for this scheme year.
KT-GB-14002: The customer already has an open application for this scheme year.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

The account number.

applicationInputs (WarmHomeDiscountApplicationInputType!)

The qualifying criterion and component for the application.

Return fields

Name Description

errors ([SerializerFieldErrorsType])

id (String)

mutation CreateWarmHomeDiscountApplication(
  $accountNumber: String!,
  $applicationInputs: WarmHomeDiscountApplicationInputType!
) {
  createWarmHomeDiscountApplication(
    accountNumber: $accountNumber,
    applicationInputs: $applicationInputs
  ) {
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
    id
  }
}

{
  "accountNumber": "abc123",
  "applicationInputs": WarmHomeDiscountApplicationInputType
}

{
  "data": {
    "createWarmHomeDiscountApplication": {
      "errors": [SerializerFieldErrorsType],
      "id": "abc123"
    }
  }
}

deauthenticateDevice

Type:DeauthenticateDevice

De-authenticate a device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4350: Unable to de-authenticate device.
KT-CT-4352: This device cannot currently be de-authenticated.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'deauthenticateDevice' field is deprecated.

Please use 'deauthenticateFlexDevice' instead.

- Marked as deprecated on 2025-05-12.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/606/

Arguments

Name Description

input (DeAuthenticationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (DeviceDetailsType)

mutation DeauthenticateDevice($input: DeAuthenticationInput) {
  deauthenticateDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...DeviceDetailsTypeFragment
    }
  }
}

{
  "input": DeAuthenticationInput
}

{
  "data": {
    "deauthenticateDevice": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": DeviceDetailsType
    }
  }
}

deauthenticateFlexDevice

Type:DeauthenticateFlexDevice

De-authenticate a device by device id.

The possible errors that can be raised are:

KT-CT-4350: Unable to de-authenticate device.
KT-CT-4352: This device cannot currently be de-authenticated.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeauthenticateFlexDeviceInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (DeviceDetailsType)

mutation DeauthenticateFlexDevice($input: DeauthenticateFlexDeviceInput) {
  deauthenticateFlexDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...DeviceDetailsTypeFragment
    }
  }
}

{
  "input": DeauthenticateFlexDeviceInput
}

{
  "data": {
    "deauthenticateFlexDevice": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": DeviceDetailsType
    }
  }
}

decommissionSmartDevice

Type:DecommissionSmartDevice

Decommissions a device using SmartPear's 'remove device' orchestration.

The possible errors that can be raised are:

KT-GB-4024: The provided device ID does not match any devices known by Kraken.
KT-GB-4050: Smart meter not found.
KT-GB-4025: Error sending the request to decommission the device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DecommissionSmartDeviceInput!)

Input fields for decommission meters.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference of the Decommission Request in Kraken.

mutation DecommissionSmartDevice($input: DecommissionSmartDeviceInput!) {
  decommissionSmartDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": DecommissionSmartDeviceInput
}

{
  "data": {
    "decommissionSmartDevice": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

deductLoyaltyPoints

Type:DeductLoyaltyPoints

Deduct the passed number of Loyalty Points from the account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-5420: Unauthorized.
KT-CT-9211: Invalid reason for loyalty points award.
KT-CT-9219: Loyalty points user not found.
KT-CT-9204: Negative or zero points set.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9221: Idempotency key already used on ledger entry.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeductLoyaltyPointsInput!)

Input fields for deducting Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsDeducted (Int)

The number of loyalty points that were deducted.

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the deducted loyalty points.

mutation DeductLoyaltyPoints($input: DeductLoyaltyPointsInput!) {
  deductLoyaltyPoints(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsDeducted
    ledgerEntry {
      ...LoyaltyPointLedgerEntryTypeFragment
    }
  }
}

{
  "input": DeductLoyaltyPointsInput
}

{
  "data": {
    "deductLoyaltyPoints": {
      "possibleErrors": [PossibleErrorType],
      "pointsDeducted": 1,
      "ledgerEntry": LoyaltyPointLedgerEntryType
    }
  }
}

deleteAccountReference

Type:DeleteAccountReference

Delete an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8312: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeleteAccountReferenceInput!)

Input fields for removing an account reference.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReference (DeleteAccountReferenceType)

mutation DeleteAccountReference($input: DeleteAccountReferenceInput!) {
  deleteAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...DeleteAccountReferenceTypeFragment
    }
  }
}

{
  "input": DeleteAccountReferenceInput
}

{
  "data": {
    "deleteAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": DeleteAccountReferenceType
    }
  }
}

deleteBoostCharge

Type:DeleteBoostCharge

Stop any active boost charging.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4354: Unable to cancel boost charge.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'deleteBoostCharge' field is deprecated.

Please use 'updateBoostCharge' instead.

- Marked as deprecated on 2025-05-12.
- Scheduled for removal on or after 2026-01-26.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/607/

Arguments

Name Description

input (DeleteBoostChargeInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation DeleteBoostCharge($input: DeleteBoostChargeInput) {
  deleteBoostCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": DeleteBoostChargeInput
}

{
  "data": {
    "deleteBoostCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

deleteMfaDevice

Type:DeleteMfaDevice

Delete MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1154: Unable to delete MFA device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

Input fields for deleting an existing multi-factor authentication device for the logged user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

deviceDeleted (Boolean)

Flag to indicate if the MFA device has been successfully deleted.

mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
  deleteMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceDeleted
  }
}

{
  "input": DeleteMfaDeviceInputType
}

{
  "data": {
    "deleteMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceDeleted": true
    }
  }
}

deletePropertyDescendants

Type:DeletePropertyDescendants

Delete all descendants of a property in a hierarchy.

This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.

The possible errors that can be raised are:

KT-CT-6622: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeletePropertyDescendantsInput!)

Input fields for deleting descendants from a property.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

property (PropertyType)

The property whose descendants were deleted.

mutation DeletePropertyDescendants($input: DeletePropertyDescendantsInput!) {
  deletePropertyDescendants(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    property {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": DeletePropertyDescendantsInput
}

{
  "data": {
    "deletePropertyDescendants": {
      "possibleErrors": [PossibleErrorType],
      "property": PropertyType
    }
  }
}

deletePushNotificationBinding

Type:DeletePushNotificationBinding

Delete a device token used for push notifications.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5411: Invalid token or no push notification binding found for the given account user.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DeletePushNotificationBindingInput!)

Input fields for deleting a push notification binding.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

status (DeletePushNotificationBindingOutput)

mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
  deletePushNotificationBinding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    status
  }
}

{
  "input": DeletePushNotificationBindingInput
}

{
  "data": {
    "deletePushNotificationBinding": {
      "possibleErrors": [PossibleErrorType],
      "status": "SUCCESSFUL"
    }
  }
}

deprovisionHeatingController

Type:DeprovisionHeatingController

De-provision a heating controller device.

The possible errors that can be raised are:

KT-CT-4307: Error deprovisioning an Octopus heat pump.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'deprovisionHeatingController' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

message (String)

The message to display to the user upon successful device de-provisioning.

mutation DeprovisionHeatingController(
  $accountNumber: String!,
  $euid: ID!
) {
  deprovisionHeatingController(
    accountNumber: $accountNumber,
    euid: $euid
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123"
}

{
  "data": {
    "deprovisionHeatingController": {
      "possibleErrors": [PossibleErrorType],
      "message": "abc123"
    }
  }
}

detachSupplyPointFromEstimationGroup

Type:DetachSupplyPointFromEstimationGroup

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-13603: Supply Point does not exist.
KT-CT-13604: Supply point has no estimation group assigned.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DetachSupplyPointFromEstimationGroupInput!)

Input fields for detaching a supply point from an estimation group.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

supplyPoint (DeletedSupplyPointEstimationGroupType)

The deleted supply point.

mutation DetachSupplyPointFromEstimationGroup($input: DetachSupplyPointFromEstimationGroupInput!) {
  detachSupplyPointFromEstimationGroup(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    supplyPoint {
      ...DeletedSupplyPointEstimationGroupTypeFragment
    }
  }
}

{
  "input": DetachSupplyPointFromEstimationGroupInput
}

{
  "data": {
    "detachSupplyPointFromEstimationGroup": {
      "possibleErrors": [PossibleErrorType],
      "supplyPoint": DeletedSupplyPointEstimationGroupType
    }
  }
}

deviceRegistration

Type:DeviceRegistration

The possible errors that can be raised are:

KT-CT-4324: Device already registered error.
KT-CT-4321: Serializer validation error.
KT-CT-4312: Unable to register device.
KT-CT-4363: No capable devices found.
KT-CT-4364: Multiple devices found.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'deviceRegistration' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-09-08.
- Scheduled for removal on or after 2026-03-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/678/

Arguments

Name Description

input (DeviceRegistrationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

registeredDeviceIds ([String])

Device ID(s) of the registered device(s).

mutation DeviceRegistration($input: DeviceRegistrationInput) {
  deviceRegistration(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    registeredDeviceIds
  }
}

{
  "input": DeviceRegistrationInput
}

{
  "data": {
    "deviceRegistration": {
      "possibleErrors": [PossibleErrorType],
      "registeredDeviceIds": ["abc123"]
    }
  }
}

directDebitPaymentDayUpdate

Type:DirectDebitPaymentDayUpdate

DEPRECATED: Please use updatePaymentSchedulePaymentDay instead

Update monthly Direct Debit payment day

This field requires the Authorization header to be set.

Deprecated

The 'directDebitPaymentDayUpdate' field is deprecated.

Please use the 'updatePaymentSchedulePaymentDay' mutation instead.

- Marked as deprecated on 2020-10-02.
- Scheduled for removal on or after 2023-04-06.

Arguments

Name Description

input (DirectDebitPaymentDayUpdateInput!)

Return fields

Name Description

paymentSchedule (PaymentScheduleType)

errors ([ErrorType])

mutation DirectDebitPaymentDayUpdate($input: DirectDebitPaymentDayUpdateInput!) {
  directDebitPaymentDayUpdate(input: $input) {
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
    errors {
      ...ErrorTypeFragment
    }
  }
}

{
  "input": DirectDebitPaymentDayUpdateInput
}

{
  "data": {
    "directDebitPaymentDayUpdate": {
      "paymentSchedule": PaymentScheduleType,
      "errors": [ErrorType]
    }
  }
}

disableAutoTopup

Type:DisableAutoTopup

Disable auto top-up for SPAYG meter.

Arguments

Name Description

input (DisableAutoTopupInput!)

Input fields for disabling auto top-up.

Return fields

Name Description

success (Boolean!)

Boolean indicating if the auto top-up was successfully disabled.

mutation DisableAutoTopup($input: DisableAutoTopupInput!) {
  disableAutoTopup(input: $input) {
    success
  }
}

{
  "input": DisableAutoTopupInput
}

{
  "data": {
    "disableAutoTopup": {
      "success": true
    }
  }
}

endContributionAgreement

Type:EndContributionAgreement

End a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-9603: Unable to find contribution agreement.
KT-CT-4123: Unauthorized.
KT-CT-9604: Unable to end contribution agreement.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (EndContributionAgreementInput!)

Input variables needed for ending a contribution agreement on an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
  endContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": EndContributionAgreementInput
}

{
  "data": {
    "endContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

enqueueInboundCall

Type:EnqueueInboundCall

The possible errors that can be raised are:

KT-CT-11802: Call not found.
KT-CT-11803: Unable to enqueue the call.
KT-CT-11817: Invalid call ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (EnqueueInboundCallInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

call (InboundCallType)

The call that was enqueued.

mutation EnqueueInboundCall($input: EnqueueInboundCallInput!) {
  enqueueInboundCall(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    call {
      ...InboundCallTypeFragment
    }
  }
}

{
  "input": EnqueueInboundCallInput
}

{
  "data": {
    "enqueueInboundCall": {
      "possibleErrors": [PossibleErrorType],
      "call": InboundCallType
    }
  }
}

enrollAccountInLoyaltyProgram

Type:EnrollAccountInLoyaltyProgram

Enroll users account in Loyalty program.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9213: ineligible loyalty points enrollment.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (EnrollAccountInLoyaltyProgramInput!)

The account number to enroll in the loyalty program.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

outcome (EnrollAccountInLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
  enrollAccountInLoyaltyProgram(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    outcome {
      ...EnrollAccountInLoyaltyProgramOutcomeFragment
    }
  }
}

{
  "input": EnrollAccountInLoyaltyProgramInput
}

{
  "data": {
    "enrollAccountInLoyaltyProgram": {
      "possibleErrors": [PossibleErrorType],
      "outcome": EnrollAccountInLoyaltyProgramOutcome
    }
  }
}

enrollFanClubAccount

Type:EnrollFanClubAccount

Enroll account up to Fan Club.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-8104: Account already enrolled.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (JoinFanClubInput!)

Input fields for joining the Fan Club.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

enrollmentOutput (EnrollFanClubAccountOutputType)

Result of the Fan Club enrollment.

mutation EnrollFanClubAccount($input: JoinFanClubInput!) {
  enrollFanClubAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    enrollmentOutput {
      ...EnrollFanClubAccountOutputTypeFragment
    }
  }
}

{
  "input": JoinFanClubInput
}

{
  "data": {
    "enrollFanClubAccount": {
      "possibleErrors": [PossibleErrorType],
      "enrollmentOutput": EnrollFanClubAccountOutputType
    }
  }
}

enrollment

Type:EnrollmentInitiated!

Initiate an enrollment for an account and a set of supply points.

The possible errors that can be raised are:

KT-CT-1602: Serializer validation error.
KT-CT-4410: Invalid postcode.
KT-CT-4412: The supplied address is not valid.
KT-CT-4501: Unauthorized.
KT-CT-7719: Session not found.
KT-CT-10312: Mutation not enabled in this environment.
KT-CT-10313: Failed to enroll account.
KT-CT-10314: This supply point is already on supply.
KT-CT-10315: Unable to begin enrollment journey due to invalid data.
KT-CT-6622: Unauthorized.
KT-CT-10340: House move enrollment is not enabled.
KT-CT-10302: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (EnrollmentInput!)

The Enrollment Input data for the Join Supplier.

Return fields

Name	Description

mutation Enrollment($input: EnrollmentInput!) {
  enrollment(input: $input) {
    enrollmentProcesses {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
    message
  }
}

{
  "input": EnrollmentInput
}

{
  "data": {
    "enrollment": {
      "enrollmentProcesses": JoinSupplierProcessType,
      "message": "abc123"
    }
  }
}

estimateElectricityMeterReading

Type:EstimateElectricityMeterReading

Estimate the reading on an electricity meter at a particular date.

The possible errors that can be raised are:

KT-GB-11013: Register not found.
KT-GB-11014: The meter and meter point do not belong to the given register.
KT-GB-11015: The specified register does not have any recorded readings.
KT-GB-11016: Unable to estimate meter reading.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'estimateElectricityMeterReading' field is deprecated.

This mutation is no longer required.

- Marked as deprecated on 2026-02-27.
- Scheduled for removal on or after 2026-03-09.

Arguments

Name Description

input (MeterReadingEstimateInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

estimate (MeterReadingEstimateType)

The meter reading estimate.

mutation EstimateElectricityMeterReading($input: MeterReadingEstimateInput!) {
  estimateElectricityMeterReading(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    estimate {
      ...MeterReadingEstimateTypeFragment
    }
  }
}

{
  "input": MeterReadingEstimateInput
}

{
  "data": {
    "estimateElectricityMeterReading": {
      "possibleErrors": [PossibleErrorType],
      "estimate": MeterReadingEstimateType
    }
  }
}

estimateGasMeterReading

Type:EstimateGasMeterReading

Estimate the reading on a gas meter at a particular date.

The possible errors that can be raised are:

KT-GB-11013: Register not found.
KT-GB-11014: The meter and meter point do not belong to the given register.
KT-GB-11015: The specified register does not have any recorded readings.
KT-GB-11016: Unable to estimate meter reading.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'estimateGasMeterReading' field is deprecated.

This mutation is no longer required.

- Marked as deprecated on 2026-02-27.
- Scheduled for removal on or after 2026-03-09.

Arguments

Name Description

input (MeterReadingEstimateInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

estimate (MeterReadingEstimateType)

The meter reading estimate.

mutation EstimateGasMeterReading($input: MeterReadingEstimateInput!) {
  estimateGasMeterReading(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    estimate {
      ...MeterReadingEstimateTypeFragment
    }
  }
}

{
  "input": MeterReadingEstimateInput
}

{
  "data": {
    "estimateGasMeterReading": {
      "possibleErrors": [PossibleErrorType],
      "estimate": MeterReadingEstimateType
    }
  }
}

expireEvPublicChargingToken

Type:ExpireEvPublicChargingToken

Expire EV Public charging token.

The possible errors that can be raised are:

KT-CT-5817: External Account not found.
KT-CT-5818: Invalid data.
KT-CT-5819: Token not found.
KT-CT-5820: Multiple tokens found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ExpireEvPublicChargingTokenInput!)

Input fields for expiring a token.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (Token)

mutation ExpireEvPublicChargingToken($input: ExpireEvPublicChargingTokenInput!) {
  expireEvPublicChargingToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...TokenFragment
    }
  }
}

{
  "input": ExpireEvPublicChargingTokenInput
}

{
  "data": {
    "expireEvPublicChargingToken": {
      "possibleErrors": [PossibleErrorType],
      "token": Token
    }
  }
}

fanClubDiscountNotification

Type:FanClubDiscountNotification

Send notification of likely Fan Club discount.

The possible errors that can be raised are:

KT-CT-8106: No catchments provided.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FanClubDiscountNotificationInput!)

Input fields for sending Fan Club discount notifications.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Boolean indicating if Fan Club notifications were triggered.

mutation FanClubDiscountNotification($input: FanClubDiscountNotificationInput!) {
  fanClubDiscountNotification(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": FanClubDiscountNotificationInput
}

{
  "data": {
    "fanClubDiscountNotification": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

fanClubNonOctopusCustomerComms

Type:FanClubNonOctopusCustomerComms

Send comms for Fan Club sign-ups from non-Octopus customers.

The possible errors that can be raised are:

KT-CT-8107: Invalid eligibility status.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FanClubNonOctopusCustomerCommsInput!)

Input fields for sending comms to non-Octopus users.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Flag for whether Fan Club comms for non-Octopus customer were sent.

mutation FanClubNonOctopusCustomerComms($input: FanClubNonOctopusCustomerCommsInput!) {
  fanClubNonOctopusCustomerComms(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": FanClubNonOctopusCustomerCommsInput
}

{
  "data": {
    "fanClubNonOctopusCustomerComms": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

fetchGeneratePaymentFingerprint

Type:FetchGeneratePaymentFingerprint

Fetch or generate payment fingerprint from vendor.

The possible errors that can be raised are:

KT-CT-12101: Payment instruction not found.
KT-CT-12102: Payment vendor not supported.
KT-CT-12103: Missing payment metadata from vendor.
KT-CT-12104: Unable to fetch or generate payment fingerprint.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FetchGeneratePaymentFingerprintInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

fingerprint (String)

Fetched or generated fingerprint from vendor.

vendor (String)

Vendor name.

mutation FetchGeneratePaymentFingerprint($input: FetchGeneratePaymentFingerprintInput!) {
  fetchGeneratePaymentFingerprint(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    fingerprint
    vendor
  }
}

{
  "input": FetchGeneratePaymentFingerprintInput
}

{
  "data": {
    "fetchGeneratePaymentFingerprint": {
      "possibleErrors": [PossibleErrorType],
      "fingerprint": "abc123",
      "vendor": "abc123"
    }
  }
}

fetchPreSignedLinkForOpportunityAttachment

Type:FetchPreSignedLinkForOpportunityAttachment

Fetch a pre-signed link for an opportunity file attachment.

The possible errors that can be raised are:

KT-CT-8933: Opportunity file attachment not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FetchPreSignedLinkForOpportunityAttachmentInput!)

Input fields for fetching a pre-signed link for an opportunity file attachment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

opportunityFileAttachment (OpportunityFileAttachment)

The opportunity file attachment with pre-signed URL.

mutation FetchPreSignedLinkForOpportunityAttachment($input: FetchPreSignedLinkForOpportunityAttachmentInput!) {
  fetchPreSignedLinkForOpportunityAttachment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityFileAttachment {
      ...OpportunityFileAttachmentFragment
    }
  }
}

{
  "input": FetchPreSignedLinkForOpportunityAttachmentInput
}

{
  "data": {
    "fetchPreSignedLinkForOpportunityAttachment": {
      "possibleErrors": [PossibleErrorType],
      "opportunityFileAttachment": OpportunityFileAttachment
    }
  }
}

fitAcceptSchedule

Type:FitAcceptSchedule

Accept a FIT schedule for a particular account.

The possible errors that can be raised are:

KT-GB-6813: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FitAcceptScheduleInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

fitSchedule (FitScheduleType)

The accepted schedule.

mutation FitAcceptSchedule($input: FitAcceptScheduleInput!) {
  fitAcceptSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    fitSchedule {
      ...FitScheduleTypeFragment
    }
  }
}

{
  "input": FitAcceptScheduleInput
}

{
  "data": {
    "fitAcceptSchedule": {
      "possibleErrors": [PossibleErrorType],
      "fitSchedule": FitScheduleType
    }
  }
}

fitAcceptTermsAndConditions

Type:FitAcceptTermsAndConditions

Accept the FiT terms and conditions.

Arguments

Name Description

fitId (String!)

The FiT id.

Return fields

Name Description

installation (InstallationType)

The FiT installation associated with the provided FiT id.

mutation FitAcceptTermsAndConditions($fitId: String!) {
  fitAcceptTermsAndConditions(fitId: $fitId) {
    installation {
      ...InstallationTypeFragment
    }
  }
}

{
  "fitId": "abc123"
}

{
  "data": {
    "fitAcceptTermsAndConditions": {
      "installation": InstallationType
    }
  }
}

fitCreateMeterReadings

Type:FitCreateMeterReadings

Submit meter readings for any FIT installations associated with a particular account.

The possible errors that can be raised are:

KT-GB-6812: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FitMeterReadingInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

readingsSubmitted (Boolean)

Whether the meter readings were successfully submitted.

mutation FitCreateMeterReadings($input: FitMeterReadingInput!) {
  fitCreateMeterReadings(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    readingsSubmitted
  }
}

{
  "input": FitMeterReadingInput
}

{
  "data": {
    "fitCreateMeterReadings": {
      "possibleErrors": [PossibleErrorType],
      "readingsSubmitted": true
    }
  }
}

fitCreateMeterReadingsViaIvr

Type:FitCreateMeterReadingsIVR

Submit meter readings for any FIT installations associated with a particular account via IVR.

The possible errors that can be raised are:

KT-GB-6812: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (FitMeterReadingInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

readingsSubmitted (Boolean)

Whether the meter readings were successfully submitted.

mutation FitCreateMeterReadingsViaIvr($input: FitMeterReadingInput!) {
  fitCreateMeterReadingsViaIvr(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    readingsSubmitted
  }
}

{
  "input": FitMeterReadingInput
}

{
  "data": {
    "fitCreateMeterReadingsViaIvr": {
      "possibleErrors": [PossibleErrorType],
      "readingsSubmitted": true
    }
  }
}

forceReauthentication

Type:ForceReauthentication

Force users of Kraken Tokens and refresh tokens issued to the viewer to reauthenticate.

Calling this mutation will cause all Kraken Tokens and refresh tokens issued to the authenticated viewer before the mutation was called to become invalid.

Arguments

Name Description

input (ForceReauthenticationInput!)

Input object argument to the force-reauthentication mutation.

Return fields

Name Description

tokensInvalidated (Boolean!)

Reports whether the mutation applied successfully. Should always be 'true'.

effectiveAt (DateTime!)

The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid.

mutation ForceReauthentication($input: ForceReauthenticationInput!) {
  forceReauthentication(input: $input) {
    tokensInvalidated
    effectiveAt
  }
}

{
  "input": ForceReauthenticationInput
}

{
  "data": {
    "forceReauthentication": {
      "tokensInvalidated": true,
      "effectiveAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

generateAffiliatesAudioRecordingPreSignedUrl

Type:GenerateAffiliatesAudioRecordingPreSignedUrl!

Generate a pre signed url for uploading a file for use with affiliates.

Arguments

Name Description

input (GenerateAffiliatesAudioRecordingPreSignedUrlInput!)

Input fields for creating a pre-signed URL for uploading an audio file to S3.

Return fields

Name	Description

mutation GenerateAffiliatesAudioRecordingPreSignedUrl($input: GenerateAffiliatesAudioRecordingPreSignedUrlInput!) {
  generateAffiliatesAudioRecordingPreSignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliatesAudioRecordingPreSignedUrl {
      ...AffiliateAudioRecordingPresignedPostTypeFragment
    }
  }
}

{
  "input": GenerateAffiliatesAudioRecordingPreSignedUrlInput
}

{
  "data": {
    "generateAffiliatesAudioRecordingPreSignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
    }
  }
}

generateInkPresignedUrl

Type:GenerateInkPresignedUrl

The possible errors that can be raised are:

KT-CT-7620: Channel not supported.
KT-CT-7618: Unable to process message.
KT-CT-7624: Error when generating the presigned URL.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GenerateInkPresignedUrlInput)

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`uploadUrl` (`String!`)	A presigned URL for the user to upload to the quarantine bucket.
`key` (`String!`)	The key for the item.
`fields` (`JSONString!`)	Presigned post fields required to upload the file.

mutation GenerateInkPresignedUrl($input: GenerateInkPresignedUrlInput) {
  generateInkPresignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    uploadUrl
    key
    fields
  }
}

{
  "input": GenerateInkPresignedUrlInput
}

{
  "data": {
    "generateInkPresignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "uploadUrl": "abc123",
      "key": "abc123",
      "fields": {"key": "value"}
    }
  }
}

generateLeadsFileAttachmentDownloadPreSignedUrl

Type:GenerateLeadsFileAttachmentDownloadPreSignedUrl

Generate a pre-signed URL for downloading a leads attachment file.

The possible errors that can be raised are:

KT-CT-8933: Opportunity file attachment not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GenerateLeadsFileAttachmentDownloadPreSignedUrlInput!)

Input fields for creating a pre-signed URL for downloading a lead file attachment from S3.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

leadsFileAttachmentDownloadPreSignedUrl (LeadsFileAttachmentDownloadPresignedUrlType)

Pre-signed S3 URL for downloading the leads file attachment.

mutation GenerateLeadsFileAttachmentDownloadPreSignedUrl($input: GenerateLeadsFileAttachmentDownloadPreSignedUrlInput!) {
  generateLeadsFileAttachmentDownloadPreSignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    leadsFileAttachmentDownloadPreSignedUrl {
      ...LeadsFileAttachmentDownloadPresignedUrlTypeFragment
    }
  }
}

{
  "input": GenerateLeadsFileAttachmentDownloadPreSignedUrlInput
}

{
  "data": {
    "generateLeadsFileAttachmentDownloadPreSignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "leadsFileAttachmentDownloadPreSignedUrl": LeadsFileAttachmentDownloadPresignedUrlType
    }
  }
}

generateLeadsFileAttachmentPreSignedUrl

Type:GenerateLeadsFileAttachmentsPreSignedUrl

Generate a pre signed url for uploading a leads attachment file.

Arguments

Name Description

input (GenerateLeadsFileAttachmentPreSignedUrlInput!)

Input fields for creating a pre-signed URL for uploading a lead file attachment file to S3.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

leadsFileAttachmentPreSignedUrl (LeadsFileAttachmentPresignedPostType)

Input fields required to generate a presigned S3 post for leads file attachment.

mutation GenerateLeadsFileAttachmentPreSignedUrl($input: GenerateLeadsFileAttachmentPreSignedUrlInput!) {
  generateLeadsFileAttachmentPreSignedUrl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    leadsFileAttachmentPreSignedUrl {
      ...LeadsFileAttachmentPresignedPostTypeFragment
    }
  }
}

{
  "input": GenerateLeadsFileAttachmentPreSignedUrlInput
}

{
  "data": {
    "generateLeadsFileAttachmentPreSignedUrl": {
      "possibleErrors": [PossibleErrorType],
      "leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
    }
  }
}

generatePaymentAllocationNumber

Type:GeneratePaymentAllocationNumber

Generate PAN for a smart prepay meter

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SmartMeterDeviceInput!)

Identifies the meter to generate a PAN for.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pan (String!)

The Payment Allocation Number routes payments made via a PSP (Payment Service Provider) to this device.

mutation GeneratePaymentAllocationNumber($input: SmartMeterDeviceInput!) {
  generatePaymentAllocationNumber(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pan
  }
}

{
  "input": SmartMeterDeviceInput
}

{
  "data": {
    "generatePaymentAllocationNumber": {
      "possibleErrors": [PossibleErrorType],
      "pan": "abc123"
    }
  }
}

generatePreSignedToken

Type:GeneratePreSignedToken

Generate a pre-signed token with a set expiry time.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-1120: The Kraken Token has expired.
KT-CT-1131: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

email (String!)

numberOfDaysAllowed (Int!)

The number of days that the token will be available for authentication (From now on).

scope (PreSignedTokenScope!)

Define (and limit) the scope of the token.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`token` (`String`)
`tokenExpiryDatetime` (`DateTime`)
`scope` (`PreSignedTokenScope`)

mutation GeneratePreSignedToken(
  $email: String!,
  $numberOfDaysAllowed: Int!,
  $scope: PreSignedTokenScope!
) {
  generatePreSignedToken(
    email: $email,
    numberOfDaysAllowed: $numberOfDaysAllowed,
    scope: $scope
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
    tokenExpiryDatetime
    scope
  }
}

{
  "email": "abc123",
  "numberOfDaysAllowed": 1,
  "scope": "SUBMIT_METER_READINGS"
}

{
  "data": {
    "generatePreSignedToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123",
      "tokenExpiryDatetime": "2020-01-01T00:00:00.000Z",
      "scope": "SUBMIT_METER_READINGS"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type:GetEmbeddedSecretForNewPaymentInstruction

Get the client secret needed to create a new payment instruction using an embedded form.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3820: Received both ledger ID and number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

secretKey (String)

mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
  getEmbeddedSecretForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

Get the client secret needed to create a new payment instruction using an embedded form without tying it to a customer.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

secretKey (String)

The client secret needed to create a new stored payment instruction.

mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
  getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type:GetHostedUrlForNewPaymentInstruction

Get the external URL where the user can set up a payment instruction.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3979: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetHostedUrlForNewPaymentInstructionInput!)

Input fields for getting the external URL for setting up a payment instruction.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

url (String)

URL at which payment instruction can be set up.

mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
  getHostedUrlForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    url
  }
}

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "url": "abc123"
    }
  }
}

getOrCreateAgreement

Type:GetOrCreateAgreement

Get an existing agreement or create a new one if it doesn't exist.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4719: No supply point found for identifier provided.
KT-CT-4910: No product exists with the given input.
KT-CT-1503: Agreement validto date must be later than validfrom date.
KT-CT-1509: Unable to create agreement.
KT-CT-1511: Cannot create overlapping agreement.
KT-CT-1512: Account type does not support agreements.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CreateAgreementInput!)

Input fields for getting or creating an agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

created (Boolean)

Indicates whether a new agreement was created (true) or an existing agreement was returned (false).

agreement (CommonAgreementType)

The agreement that was retrieved or created.

mutation GetOrCreateAgreement($input: CreateAgreementInput!) {
  getOrCreateAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    created
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

{
  "input": CreateAgreementInput
}

{
  "data": {
    "getOrCreateAgreement": {
      "possibleErrors": [PossibleErrorType],
      "created": true,
      "agreement": CommonAgreementType
    }
  }
}

grantUserAccessToBusiness

Type:GrantUserAccessToBusiness

Grant user access to the business using the provided role.

The possible errors that can be raised are:

KT-CT-5463: Unauthorized.
KT-CT-11107: Unauthorized.
KT-CT-13501: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GrantUserAccessToBusinessInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation GrantUserAccessToBusiness($input: GrantUserAccessToBusinessInput!) {
  grantUserAccessToBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": GrantUserAccessToBusinessInput
}

{
  "data": {
    "grantUserAccessToBusiness": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

initializeAccount

Type:InitializeAccountResult!

Initialize account for sign up. Returns the existing account if matching datafound for the provided input, otherwise creates a new account.

The possible errors that can be raised are:

KT-CT-10324: Mutation not enabled in this environment.
KT-CT-10325: Input data has invalid format.
KT-CT-10326: An error occurred when trying to initialize the account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (BaseInitializeAccountInput!)

Return fields

Name	Description

mutation InitializeAccount($input: BaseInitializeAccountInput!) {
  initializeAccount(input: $input) {
    isNewAccount
    accountNumber
  }
}

{
  "input": BaseInitializeAccountInput
}

{
  "data": {
    "initializeAccount": {
      "isNewAccount": true,
      "accountNumber": "abc123"
    }
  }
}

initializeUser

Type:InitializeUserResult!

Initialize user for sign up. Returns an existing user if matching datafound for the provided input, otherwise creates a new one.

The possible errors that can be raised are:

KT-CT-10327: Mutation not enabled in this environment.
KT-CT-10328: Input data has invalid format.
KT-CT-10329: An error occurred when trying to initialize the user.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (BaseInitializeUserInput!)

Return fields

Name	Description

mutation InitializeUser($input: BaseInitializeUserInput!) {
  initializeUser(input: $input) {
    isNewUser
    userNumber
  }
}

{
  "input": BaseInitializeUserInput
}

{
  "data": {
    "initializeUser": {
      "isNewUser": true,
      "userNumber": "abc123"
    }
  }
}

initiateHostedStandalonePayment

Type:InitiateHostedStandalonePayment

Initiate a standalone payment and return the url where the customer can complete it.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-3957: No collection method provided.
KT-CT-3958: Provide either ledger ID or ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (InitiateHostedStandalonePaymentOutput)

The details required to refer to and complete a hosted payment.

mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
  initiateHostedStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateHostedStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateHostedStandalonePaymentInput
}

{
  "data": {
    "initiateHostedStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateHostedStandalonePaymentOutput
    }
  }
}

initiateProductSwitch

Type:InitiateProductSwitch

Do a product switch for a user.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4619: Quote with given code not found.
KT-CT-4624: Unable to accept the given product code.
KT-CT-4924: Unauthorized.
KT-CT-4626: No product selected for the given quote code.
KT-CT-4719: No supply point found for identifier provided.
KT-CT-1509: Unable to create agreement.
KT-CT-1507: Agreement product switch date is not within the acceptable range.
KT-CT-4640: Unable to get market or client params from quoted product.
KT-CT-4627: No products are available for this quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateProductSwitchInput!)

Instigate a product switch for a specific supply point given a valid product and account number.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

productCode (String!)

The selected product for a specific product switch.

switchDate (Date!)

The date at which the product switch becomes effective.

mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
  initiateProductSwitch(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    productCode
    switchDate
  }
}

{
  "input": InitiateProductSwitchInput
}

{
  "data": {
    "initiateProductSwitch": {
      "possibleErrors": [PossibleErrorType],
      "productCode": "abc123",
      "switchDate": "2020-01-01"
    }
  }
}

initiateStandalonePayment

Type:InitiateStandalonePayment

Initiate a standalone payment and return the client secret required to complete it.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (InitiateStandalonePaymentOutput)

mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
  initiateStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateStandalonePaymentInput
}

{
  "data": {
    "initiateStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateStandalonePaymentOutput
    }
  }
}

initiateUnauthenticatedStandalonePayment

Type:InitiateUnauthenticatedStandalonePayment

Initiate an unauthenticated standalone payment and return the client secret required to complete it.

Arguments

Name Description

input (InitiateUnauthenticatedStandalonePaymentInput!)

Input fields for initiating an unauthenticated standalone payment.

Return fields

Name Description

payment (InitiateUnauthenticatedStandalonePaymentOutput)

The payment's retrieval and secret tokens.

mutation InitiateUnauthenticatedStandalonePayment($input: InitiateUnauthenticatedStandalonePaymentInput!) {
  initiateUnauthenticatedStandalonePayment(input: $input) {
    payment {
      ...InitiateUnauthenticatedStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateUnauthenticatedStandalonePaymentInput
}

{
  "data": {
    "initiateUnauthenticatedStandalonePayment": {
      "payment": InitiateUnauthenticatedStandalonePaymentOutput
    }
  }
}

instigateContractTermination

Type:ContractTerminationInstigated!

Instigate a contract termination journey.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10004: Supply loss process instigation has failed.
KT-CT-10007: Unable to terminate contract.
KT-CT-10008: The contract is currently undergoing an active journey.
KT-CT-10013: Requested termination date is invalid.
KT-CT-10014: The provided contract termination input data is invalid.
KT-CT-10015: Supply point termination context is not serializable.
KT-CT-10016: Error building contract termination engine.
KT-CT-10022: Contract already terminated.
KT-CT-10023: Contract is already revoked.
KT-CT-10024: Contract already expired.
KT-CT-10025: Contract has not started yet.
KT-CT-10037: Contract notes feature is disabled.
KT-CT-10038: Contract note reason not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (BaseInstigateContractTerminationInput!)

Return fields

Name	Description

mutation InstigateContractTermination($input: BaseInstigateContractTerminationInput!) {
  instigateContractTermination(input: $input) {
    message
  }
}

{
  "input": BaseInstigateContractTerminationInput
}

{
  "data": {
    "instigateContractTermination": {
      "message": "abc123"
    }
  }
}

instigateContractVariation

Type:InstigateContractVariationOutput!

Instigate a contract variation journey.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10008: The contract is currently undergoing an active journey.
KT-CT-10011: Unable to vary contract terms.
KT-CT-10033: Unable to save term.
KT-CT-10012: Contract variation implies breach.
KT-CT-10034: Unknown contract journey type.
KT-CT-10035: Cannot process a non-active contract journey.
KT-CT-10036: The contract journey manager is not found.
KT-CT-10037: Contract notes feature is disabled.
KT-CT-10038: Contract note reason not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'instigateContractVariation' field is deprecated.

This is a legacy mutation. The varyContractTerms should be used instead.

- Marked as deprecated on 2026-03-05.
- Scheduled for removal on or after 2026-04-11.

Arguments

Name Description

input (InstigateContractVariationInput!)

Return fields

Name	Description

mutation InstigateContractVariation($input: InstigateContractVariationInput!) {
  instigateContractVariation(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

{
  "input": InstigateContractVariationInput
}

{
  "data": {
    "instigateContractVariation": {
      "contract": Contract
    }
  }
}

instigateLeaveSupplier

Type:LeaveSupplierInstigated!

Instigate a leave supplier process or update an existing process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-4501: Unauthorized.
KT-CT-10301: Unable to instigate leave supplier process.
KT-CT-10330: Unsupported leave supplier type.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (LeaveSupplierInput!)

Return fields

Name	Description

mutation InstigateLeaveSupplier($input: LeaveSupplierInput!) {
  instigateLeaveSupplier(input: $input) {
    number
    leaveSupplierProcessId
    message
  }
}

{
  "input": LeaveSupplierInput
}

{
  "data": {
    "instigateLeaveSupplier": {
      "number": "abc123",
      "leaveSupplierProcessId": "abc123",
      "message": "abc123"
    }
  }
}

invalidatePaymentInstruction

Type:InvalidatePaymentInstruction

Invalidate an existing instruction.

The possible errors that can be raised are:

KT-CT-3926: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidatePaymentInstructionInput!)

Input fields for invalidating a payment instruction from an embedded form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

instruction (InvalidatePaymentInstructionOutput)

mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
  invalidatePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    instruction {
      ...InvalidatePaymentInstructionOutputFragment
    }
  }
}

{
  "input": InvalidatePaymentInstructionInput
}

{
  "data": {
    "invalidatePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "instruction": InvalidatePaymentInstructionOutput
    }
  }
}

invalidatePreSignedToken

Type:InvalidatePreSignedToken

Invalidate a previously-issued pre-signed token.

The possible errors that can be raised are:

KT-CT-1129: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (InvalidatePreSignedTokenInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (PreSignedToken)

mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
  invalidatePreSignedToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...PreSignedTokenFragment
    }
  }
}

{
  "input": InvalidatePreSignedTokenInput
}

{
  "data": {
    "invalidatePreSignedToken": {
      "possibleErrors": [PossibleErrorType],
      "token": PreSignedToken
    }
  }
}

invalidatePreSignedTokensForUser

Type:InvalidatePreSignedTokensForUser

Invalidate pre-signed tokens issued to a particular user.

The possible errors that can be raised are:

KT-CT-1129: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidatePreSignedTokensForUserInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

tokens ([PreSignedToken])

mutation InvalidatePreSignedTokensForUser($input: InvalidatePreSignedTokensForUserInput!) {
  invalidatePreSignedTokensForUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tokens {
      ...PreSignedTokenFragment
    }
  }
}

{
  "input": InvalidatePreSignedTokensForUserInput
}

{
  "data": {
    "invalidatePreSignedTokensForUser": {
      "possibleErrors": [PossibleErrorType],
      "tokens": [PreSignedToken]
    }
  }
}

invalidateRefreshToken

Type:InvalidateRefreshToken

Invalidate a previously-issued refresh token.

The possible errors that can be raised are:

KT-CT-1130: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidateRefreshTokenInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (RefreshToken)

mutation InvalidateRefreshToken($input: InvalidateRefreshTokenInput!) {
  invalidateRefreshToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...RefreshTokenFragment
    }
  }
}

{
  "input": InvalidateRefreshTokenInput
}

{
  "data": {
    "invalidateRefreshToken": {
      "possibleErrors": [PossibleErrorType],
      "token": RefreshToken
    }
  }
}

invalidateRefreshTokensForUser

Type:InvalidateRefreshTokensForUser

Invalidate refresh tokens issued to a particular user.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidateRefreshTokensForUserInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

tokens ([RefreshToken])

mutation InvalidateRefreshTokensForUser($input: InvalidateRefreshTokensForUserInput!) {
  invalidateRefreshTokensForUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tokens {
      ...RefreshTokenFragment
    }
  }
}

{
  "input": InvalidateRefreshTokensForUserInput
}

{
  "data": {
    "invalidateRefreshTokensForUser": {
      "possibleErrors": [PossibleErrorType],
      "tokens": [RefreshToken]
    }
  }
}

joinConsumerDevice

Type:JoinConsumerDevice

Triggers the orchestration to join the PPMID, IHD, CAD or Alt HAN device to the ESME, GSME, GPF and/or CHF. This should be called after a meter has been commissioned.

The possible errors that can be raised are:

KT-GB-4053: Fuel type should not be specified for Alt HAN device.
KT-GB-4031: Error sending the request to join the device to the CHF.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (JoinConsumerDeviceInput!)

Input fields for join device.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference of the join PPMID, IHD, CAD or Alt HAN request in Kraken.

mutation JoinConsumerDevice($input: JoinConsumerDeviceInput!) {
  joinConsumerDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": JoinConsumerDeviceInput
}

{
  "data": {
    "joinConsumerDevice": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

joinDeviceToNetwork

Type:JoinDeviceToNetwork

Joins a device to a HAN (Home Area Network).

The possible errors that can be raised are:

KT-GB-4019: This device type is not currently supported.
KT-GB-4020: Error sending the request to join the device to the Home Area Network.
KT-GB-4057: MPxN is required for the specified device type.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name	Description
`chfDeviceId` (`String!`)	Device ID of the CHF (Communications Hub Function).
`installCode` (`String`)	Code that authorises joining of the device to the HAN.
`mpxn` (`String`)	MPAN/MPRN of the meter or HCALCS to join to the HAN.
`newDeviceId` (`String!`)	Device ID of the device to join to the HAN.
`newDeviceType` (`JoinableDeviceType!`)	Type of device that is being joined to the HAN.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

mutation JoinDeviceToNetwork(
  $chfDeviceId: String!,
  $installCode: String,
  $mpxn: String,
  $newDeviceId: String!,
  $newDeviceType: JoinableDeviceType!
) {
  joinDeviceToNetwork(
    chfDeviceId: $chfDeviceId,
    installCode: $installCode,
    mpxn: $mpxn,
    newDeviceId: $newDeviceId,
    newDeviceType: $newDeviceType
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "chfDeviceId": "abc123",
  "installCode": "abc123",
  "mpxn": "abc123",
  "newDeviceId": "abc123",
  "newDeviceType": "ELECTRICITY_METER"
}

{
  "data": {
    "joinDeviceToNetwork": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

joinOctoplusCampaign

Type:JoinOctoplusCampaign

Enrolls an account in the Octoplus campaign.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-GB-9310: Account ineligible for joining Octoplus.
KT-GB-9311: Error joining campaign.
KT-GB-9312: Account already signed up to Octoplus.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

accountNumber (String)

Kraken account number.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Returns mutation success.

Deprecated

The 'success' field is deprecated.

Use `outcome` instead.

- Marked as deprecated on 2023-10-12.
- Scheduled for removal on or after 2026-10-12.

outcome (EnrolmentOutcome)

Outcome of the Octoplus enrollment.

mutation JoinOctoplusCampaign($accountNumber: String) {
  joinOctoplusCampaign(accountNumber: $accountNumber) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
    outcome {
      ...EnrolmentOutcomeFragment
    }
  }
}

{
  "accountNumber": "abc123"
}

{
  "data": {
    "joinOctoplusCampaign": {
      "possibleErrors": [PossibleErrorType],
      "success": true,
      "outcome": EnrolmentOutcome
    }
  }
}

joinSavingSessionsCampaign

Type:JoinSavingSessionsCampaign

Sign account up to Saving Sessions campaign.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-GB-5110: Campaign not found.
KT-GB-5111: Meter point not found.
KT-GB-5112: Error joining campaign.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'joinSavingSessionsCampaign' field is deprecated.

Saving Sessions will no longer be supported via Kraken.

- Marked as deprecated on 2026-02-18.
- Scheduled for removal on or after 2026-03-31.

Arguments

Name Description

input (JoinSavingSessionsCampaignInput!)

Input fields for joining the Saving Sessions campaign.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (SavingSessionsAccountReturnType)

mutation JoinSavingSessionsCampaign($input: JoinSavingSessionsCampaignInput!) {
  joinSavingSessionsCampaign(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...SavingSessionsAccountReturnTypeFragment
    }
  }
}

{
  "input": JoinSavingSessionsCampaignInput
}

{
  "data": {
    "joinSavingSessionsCampaign": {
      "possibleErrors": [PossibleErrorType],
      "account": SavingSessionsAccountReturnType
    }
  }
}

joinSavingSessionsEvent

Type:JoinSavingSessionsEvent

Opt account in to a Saving Sessions event.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-GB-5114: Saving Sessions event not found.
KT-GB-5116: Account is not part of a Saving Sessions campaign.
KT-GB-5117: Account ineligible to join Saving Sessions event.
KT-GB-5115: Error joining event.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'joinSavingSessionsEvent' field is deprecated.

Saving Sessions will no longer be supported via Kraken.

- Marked as deprecated on 2026-02-18.
- Scheduled for removal on or after 2026-03-31.

Arguments

Name Description

input (JoinSavingSessionsEventInput!)

Input fields for joining a Saving Sessions event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

joinedEventCodes ([String])

The event codes that the account has joined.

mutation JoinSavingSessionsEvent($input: JoinSavingSessionsEventInput!) {
  joinSavingSessionsEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    joinedEventCodes
  }
}

{
  "input": JoinSavingSessionsEventInput
}

{
  "data": {
    "joinSavingSessionsEvent": {
      "possibleErrors": [PossibleErrorType],
      "joinedEventCodes": ["abc123"]
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type:JoinSupplierAcceptTermsAndConditions

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4501: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (JoinSupplierAcceptTermsAndConditionsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Indicator that the mutation has completed successfully.

mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
  joinSupplierAcceptTermsAndConditions(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

{
  "data": {
    "joinSupplierAcceptTermsAndConditions": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

legacyProcessOrder

Type:LegacyProcessOrderOutput!

Process an Order (legacy)

The possible errors that can be raised are:

KT-CT-1605: Invalid input.
KT-CT-7701: The affiliate organisation was not found.
KT-CT-8906: Opportunity not found.
KT-CT-12701: Invalid sales channel code.
KT-CT-13102: Invalid order data.
KT-CT-13103: Unprocessable order.
KT-CT-13104: Conflicting order.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (LegacyProcessOrderInput!)

Return fields

Name	Description

mutation LegacyProcessOrder($input: LegacyProcessOrderInput!) {
  legacyProcessOrder(input: $input) {
    status
    identifier
    resources {
      ...LegacyOrderResourceFragment
    }
  }
}

{
  "input": LegacyProcessOrderInput
}

{
  "data": {
    "legacyProcessOrder": {
      "status": "PENDING",
      "identifier": NonEmptyString,
      "resources": [LegacyOrderResource]
    }
  }
}

linkAccountToBusiness

Type:LinkAccountToBusiness

Link an account to a business.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11104: Business role already allocated.
KT-CT-11105: Business role already allocated.
KT-CT-11106: Unauthorized.
KT-CT-11107: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (LinkAccountToBusinessInput!)

Input fields for linking an account to a business.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

business (BusinessType)

The business the account was linked to.

mutation LinkAccountToBusiness($input: LinkAccountToBusinessInput!) {
  linkAccountToBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    business {
      ...BusinessTypeFragment
    }
  }
}

{
  "input": LinkAccountToBusinessInput
}

{
  "data": {
    "linkAccountToBusiness": {
      "possibleErrors": [PossibleErrorType],
      "business": BusinessType
    }
  }
}

linkUserToLine

Type:LinkUserToLineResponse!

Link an account user and line user together.

Arguments

Name Description

input (LinkUserToLineInput!)

Input fields to link an account user with LINE.

Return fields

Name	Description

mutation LinkUserToLine($input: LinkUserToLineInput!) {
  linkUserToLine(input: $input) {
    ... on LineLinkRedirectResponse {
      ...LineLinkRedirectResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on AlreadyLinkedError {
      ...AlreadyLinkedErrorFragment
    }
  }
}

{
  "input": LinkUserToLineInput
}

{
  "data": {
    "linkUserToLine": LineLinkRedirectResponse
  }
}

markPrintBatchAsProcessed

Type:MarkPrintBatchAsProcessed!

Mark the print batch as processed.

The possible errors that can be raised are:

KT-CT-9011: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

printBatchId (ID!)

Return fields

Name	Description

mutation MarkPrintBatchAsProcessed($printBatchId: ID!) {
  markPrintBatchAsProcessed(printBatchId: $printBatchId) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    printBatch {
      ...PrintBatchTypeFragment
    }
  }
}

{
  "printBatchId": "abc123"
}

{
  "data": {
    "markPrintBatchAsProcessed": {
      "possibleErrors": [PossibleErrorType],
      "printBatch": PrintBatchType
    }
  }
}

masqueradeAuthentication

Type:MasqueradeAuthentication

Provide a temporary token to get an auth token. This is intended to allow support users to view customer data through the brand interface.

Arguments

Name Description

masqueradeToken (String!)

The masquerade token issued by the support site.

userId (String!)

The ID of the AccountUser to masquerade as.

Return fields

Name Description

token (String)

A Kraken Token that can be used to authenticate to the API, masquerading as the desired user.

errors ([ErrorType])

A list of any errors that occurred while running this mutation.

mutation MasqueradeAuthentication(
  $masqueradeToken: String!,
  $userId: String!
) {
  masqueradeAuthentication(
    masqueradeToken: $masqueradeToken,
    userId: $userId
  ) {
    token
    errors {
      ...ErrorTypeFragment
    }
  }
}

{
  "masqueradeToken": "abc123",
  "userId": "abc123"
}

{
  "data": {
    "masqueradeAuthentication": {
      "token": "abc123",
      "errors": [ErrorType]
    }
  }
}

moveToBucket

Type:MoveToBucket

The possible errors that can be raised are:

KT-CT-7612: The Ink conversation was not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MoveToBucketInput)

Input for moving a conversation to a bucket.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

conversation (InkConversation!)

The conversation that was moved to the bucket.

mutation MoveToBucket($input: MoveToBucketInput) {
  moveToBucket(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    conversation {
      ...InkConversationFragment
    }
  }
}

{
  "input": MoveToBucketInput
}

{
  "data": {
    "moveToBucket": {
      "possibleErrors": [PossibleErrorType],
      "conversation": InkConversation
    }
  }
}

nextOperationsTeamRoundRobin

Type:NextOperationsTeamRoundRobin

Arguments

Name Description

teamGroupName (String!)

The name of the operations team group to select from.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`team` (`Team!`)	The next operations team assigned in round-robin sequence.
`location` (`TeamLocation!`)	Location routing information for the selected team.
`teamGroups` (`[TeamGroup]!`)	All operations team groups that the selected team belongs to.
`allInferredRoutingAttributes` (`[String]!`)	All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONSGROUP.TEAM.TeamA', 'OPERATIONSGROUP.LOCATION.London', 'OPERATIONSGROUP.GROUP_B']). Recommended for IVR usage.

mutation NextOperationsTeamRoundRobin($teamGroupName: String!) {
  nextOperationsTeamRoundRobin(teamGroupName: $teamGroupName) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    team {
      ...TeamFragment
    }
    location {
      ...TeamLocationFragment
    }
    teamGroups {
      ...TeamGroupFragment
    }
    allInferredRoutingAttributes
  }
}

{
  "teamGroupName": "abc123"
}

{
  "data": {
    "nextOperationsTeamRoundRobin": {
      "possibleErrors": [PossibleErrorType],
      "team": Team,
      "location": TeamLocation,
      "teamGroups": TeamGroup,
      "allInferredRoutingAttributes": "abc123"
    }
  }
}

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

Create a Kraken Token (JWT) for authentication.

Provide the required input fields to obtain the token.

The token should be used as the Authorization header for any authenticated requests.

The possible errors that can be raised are:

KT-CT-1135: Invalid data.
KT-CT-1134: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ObtainJSONWebTokenInput!)

Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`token` (`String!`)	The Kraken Token. Can be used in the `Authorization` header for subsequent calls to the API to access protected resources.
`payload` (`GenericScalar!`)	The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the `token` field.
`refreshToken` (`String`)	A token that can be used in a subsequent call to `obtainKrakenToken` to get a new Kraken Token with the same access conditions after the previous one has expired.
`refreshExpiresIn` (`Int`)	A Unix timestamp representing the point in time at which the refresh token will expire.

mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
  obtainKrakenToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
    payload
    refreshToken
    refreshExpiresIn
  }
}

{
  "input": ObtainJSONWebTokenInput
}

{
  "data": {
    "obtainKrakenToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123",
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

obtainLongLivedRefreshToken

Type:ObtainLongLivedRefreshToken

For authorized third-party organizations only.

The possible errors that can be raised are:

KT-CT-1120: The Kraken Token has expired.
KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
KT-CT-1132: Unauthorized.
KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ObtainLongLivedRefreshTokenInput!)

Input fields for obtaining a long-lived refresh token to extend the expiry claim of a Kraken token.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

refreshToken (String)

refreshExpiresIn (Int!)

mutation ObtainLongLivedRefreshToken($input: ObtainLongLivedRefreshTokenInput!) {
  obtainLongLivedRefreshToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    refreshToken
    refreshExpiresIn
  }
}

{
  "input": ObtainLongLivedRefreshTokenInput
}

{
  "data": {
    "obtainLongLivedRefreshToken": {
      "possibleErrors": [PossibleErrorType],
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

occupy

Type:OccupyOutputType

Add details to an existing occupier account.

The possible errors that can be raised are:

KT-GB-6622: Account not found.
KT-GB-6623: Property not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OccupyInput!)

Return fields

Name Description

account (AccountInterface)

mutation Occupy($input: OccupyInput!) {
  occupy(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": OccupyInput
}

{
  "data": {
    "occupy": {
      "account": AccountInterface
    }
  }
}

ocppAuthentication

Type:OCPPAuthentication

Trigger OCPP authentication.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4310: Unable to register OCPP authentication details.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (OCPPAuthenticationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation OcppAuthentication($input: OCPPAuthenticationInput) {
  ocppAuthentication(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": OCPPAuthenticationInput
}

{
  "data": {
    "ocppAuthentication": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

octoHeatPumpBulkUpdateSensorDisplayName

Type:BulkUpdateSensorDisplayName

Update the display name of multiple sensors.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

updates ([SensorDisplayNameUpdate]!)

A list of sensor codes and display names to set.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionIds ([SensorUpdateTransactionId])

A mapping of transaction ids for each sensor.

mutation OctoHeatPumpBulkUpdateSensorDisplayName(
  $accountNumber: String!,
  $euid: ID!,
  $updates: [SensorDisplayNameUpdate]!
) {
  octoHeatPumpBulkUpdateSensorDisplayName(
    accountNumber: $accountNumber,
    euid: $euid,
    updates: $updates
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionIds {
      ...SensorUpdateTransactionIdFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "updates": SensorDisplayNameUpdate
}

{
  "data": {
    "octoHeatPumpBulkUpdateSensorDisplayName": {
      "possibleErrors": [PossibleErrorType],
      "transactionIds": [SensorUpdateTransactionId]
    }
  }
}

octoHeatPumpBulkUpdateZoneDisplayNames

Type:BulkUpdateZoneDisplayNames

Update the display name of multiple zones of the heat pump.

The possible errors that can be raised are:

KT-CT-4384: Error trying to update heat pump zone names.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'octoHeatPumpBulkUpdateZoneDisplayNames' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

euid (ID!)

The EUID of the heat pump controller.

updates ([SetZoneDisplayNameParameters]!)

A list of zone codes mapped to each zone's new display name.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionIds ([ZoneDisplayNameUpdates]!)

The transaction ID for each zone based on the zone code.

mutation OctoHeatPumpBulkUpdateZoneDisplayNames(
  $euid: ID!,
  $updates: [SetZoneDisplayNameParameters]!
) {
  octoHeatPumpBulkUpdateZoneDisplayNames(
    euid: $euid,
    updates: $updates
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionIds {
      ...ZoneDisplayNameUpdatesFragment
    }
  }
}

{
  "euid": "abc123",
  "updates": SetZoneDisplayNameParameters
}

{
  "data": {
    "octoHeatPumpBulkUpdateZoneDisplayNames": {
      "possibleErrors": [PossibleErrorType],
      "transactionIds": ZoneDisplayNameUpdates
    }
  }
}

octoHeatPumpDeprovisionHeatingController

Type:DeprovisionHeatingController

De-provision a heating controller device.

The possible errors that can be raised are:

KT-CT-4307: Error deprovisioning an Octopus heat pump.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

message (String)

The message to display to the user upon successful device de-provisioning.

mutation OctoHeatPumpDeprovisionHeatingController(
  $accountNumber: String!,
  $euid: ID!
) {
  octoHeatPumpDeprovisionHeatingController(
    accountNumber: $accountNumber,
    euid: $euid
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123"
}

{
  "data": {
    "octoHeatPumpDeprovisionHeatingController": {
      "possibleErrors": [PossibleErrorType],
      "message": "abc123"
    }
  }
}

octoHeatPumpRebootController

Type:RebootHeatingController

Reboot the given heating controller.

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'octoHeatPumpRebootController' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

The unique ID associated with this reboot operation.

mutation OctoHeatPumpRebootController(
  $accountNumber: String!,
  $euid: ID!
) {
  octoHeatPumpRebootController(
    accountNumber: $accountNumber,
    euid: $euid
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123"
}

{
  "data": {
    "octoHeatPumpRebootController": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpRemoveSensor

Type:RemoveSensor

Remove a sensor from a heating controller device.

The possible errors that can be raised are:

KT-CT-4309: Error trying to remove sensor from heat pump controller.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'removeSensor' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

sensorId (String!)

The sensor ID of heat pump controller's sensor to be removed.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with removing a sensor from a heat pump controller.

mutation OctoHeatPumpRemoveSensor(
  $accountNumber: String!,
  $euid: ID!,
  $sensorId: String!
) {
  octoHeatPumpRemoveSensor(
    accountNumber: $accountNumber,
    euid: $euid,
    sensorId: $sensorId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "sensorId": "abc123"
}

{
  "data": {
    "octoHeatPumpRemoveSensor": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpRequestProvisioningClaimCertificate

Type:RequestProvisioningClaimCertificate

Request a certificate to provision a heating controller.

The possible errors that can be raised are:

KT-CT-4332: Invalid data.
KT-CT-4304: Error in preprovisioning step for Octopus Heat Pump.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'requestProvisioningClaimCertificate' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

propertyId (ID)

The primary key of a property you would like to associate with this controller.

requestParameters (ProvisioningClaimRequestParameters!)

Parameters requested by the app from the controller, required for Kraken Flex to authenticate the device.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

provisioningClaimBundle (ProvisioningClaimBundle)

The certificate and private key required to create a provisioning claim.

mutation OctoHeatPumpRequestProvisioningClaimCertificate(
  $accountNumber: String!,
  $propertyId: ID,
  $requestParameters: ProvisioningClaimRequestParameters!
) {
  octoHeatPumpRequestProvisioningClaimCertificate(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    requestParameters: $requestParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    provisioningClaimBundle {
      ...ProvisioningClaimBundleFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "propertyId": "abc123",
  "requestParameters": ProvisioningClaimRequestParameters
}

{
  "data": {
    "octoHeatPumpRequestProvisioningClaimCertificate": {
      "possibleErrors": [PossibleErrorType],
      "provisioningClaimBundle": ProvisioningClaimBundle
    }
  }
}

octoHeatPumpSetQuieterMode

Type:SetQuieterMode

Enable or disable quieter mode for the heat pump.

Deprecated

The 'octoHeatPumpSetQuieterMode' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

euid (ID!)

The EUID of the heat pump controller.

quieterModeEnabled (Boolean!)

Whether quieter mode should be enabled for this heat pump controller.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with this operation.

mutation OctoHeatPumpSetQuieterMode(
  $euid: ID!,
  $quieterModeEnabled: Boolean!
) {
  octoHeatPumpSetQuieterMode(
    euid: $euid,
    quieterModeEnabled: $quieterModeEnabled
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "euid": "abc123",
  "quieterModeEnabled": true
}

{
  "data": {
    "octoHeatPumpSetQuieterMode": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpSetZoneMode

Type:SetZoneMode

Turn a specific heating controller zone ON/OFF, set it to AUTO mode or give it a BOOST.

The possible errors that can be raised are:

KT-CT-4333: Invalid data.
KT-CT-4306: Error setting mode for heat pump controller zone.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'setZoneMode' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

operationParameters (SetZoneModeParameters!)

The parameters required to instruct a specific zone operation.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with a zone's mode operation.

mutation OctoHeatPumpSetZoneMode(
  $accountNumber: String!,
  $euid: ID!,
  $operationParameters: SetZoneModeParameters!
) {
  octoHeatPumpSetZoneMode(
    accountNumber: $accountNumber,
    euid: $euid,
    operationParameters: $operationParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "operationParameters": SetZoneModeParameters
}

{
  "data": {
    "octoHeatPumpSetZoneMode": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpSetZonePrimarySensor

Type:SetZonePrimarySensor

Set the primary sensor for a zone.

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'octoHeatPumpSetZonePrimarySensor' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

operationParameters (SetZonePrimarySensorParameters!)

The parameters required to set a new primary sensor for a zone.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

The unique ID associated with this operation.

mutation OctoHeatPumpSetZonePrimarySensor(
  $accountNumber: String!,
  $euid: ID!,
  $operationParameters: SetZonePrimarySensorParameters!
) {
  octoHeatPumpSetZonePrimarySensor(
    accountNumber: $accountNumber,
    euid: $euid,
    operationParameters: $operationParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "operationParameters": SetZonePrimarySensorParameters
}

{
  "data": {
    "octoHeatPumpSetZonePrimarySensor": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpSetZoneSchedules

Type:SetZoneSchedules

Add schedules for a heating controller zone.

The possible errors that can be raised are:

KT-CT-4334: Invalid data.
KT-CT-4308: Error setting schedule(s) for heat pump controller zone.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'setZoneSchedules' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

zoneScheduleParameters (SetZoneSchedulesParameters!)

The parameters required to add schedule(s) for a specific zone.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with adding schedule(s) for a zone.

mutation OctoHeatPumpSetZoneSchedules(
  $accountNumber: String!,
  $euid: ID!,
  $zoneScheduleParameters: SetZoneSchedulesParameters!
) {
  octoHeatPumpSetZoneSchedules(
    accountNumber: $accountNumber,
    euid: $euid,
    zoneScheduleParameters: $zoneScheduleParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "zoneScheduleParameters": SetZoneSchedulesParameters
}

{
  "data": {
    "octoHeatPumpSetZoneSchedules": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpUpdateFlowTemperatureConfiguration

Type:UpdateFlowTemperatureConfiguration

Update the flow temperature configuration for the heat pump.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'octoHeatPumpUpdateFlowTemperatureConfiguration' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

euid (ID!)

The EUID of the heat pump controller.

flowTemperatureInput (FlowTemperatureInput!)

Flow temperature configuration parameters.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with this operation.

mutation OctoHeatPumpUpdateFlowTemperatureConfiguration(
  $euid: ID!,
  $flowTemperatureInput: FlowTemperatureInput!
) {
  octoHeatPumpUpdateFlowTemperatureConfiguration(
    euid: $euid,
    flowTemperatureInput: $flowTemperatureInput
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "euid": "abc123",
  "flowTemperatureInput": FlowTemperatureInput
}

{
  "data": {
    "octoHeatPumpUpdateFlowTemperatureConfiguration": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpUpdateSensorDisplayName

Type:UpdateSensorDisplayName

Update the display name of a sensor.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'updateSensorDisplayName' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name	Description
`accountNumber` (`String!`)	The account number.
`displayName` (`String!`)	The new display name.
`euid` (`ID!`)	The EUID of the heat pump controller.
`sensorCode` (`String!`)	The code of the sensor to rename (such as 'SENSOR01').

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with updating a sensor attribute.

mutation OctoHeatPumpUpdateSensorDisplayName(
  $accountNumber: String!,
  $displayName: String!,
  $euid: ID!,
  $sensorCode: String!
) {
  octoHeatPumpUpdateSensorDisplayName(
    accountNumber: $accountNumber,
    displayName: $displayName,
    euid: $euid,
    sensorCode: $sensorCode
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "displayName": "abc123",
  "euid": "abc123",
  "sensorCode": "abc123"
}

{
  "data": {
    "octoHeatPumpUpdateSensorDisplayName": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

octoHeatPumpUpdateWaterSetpoint

Type:UpdateWaterSetpoint

Set the temperature for the hot water.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'updateWaterSetpoint' field is deprecated.

This mutation has been migrated to Octopus Energy backend. Please see https://api.backend.octopus.energy/v1/graphql.

- Marked as deprecated on 2026-03-18.
- Scheduled for removal on or after 2026-04-30.

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

setpoint (Int!)

The temperature to set the water to.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with this operation.

mutation OctoHeatPumpUpdateWaterSetpoint(
  $accountNumber: String!,
  $euid: ID!,
  $setpoint: Int!
) {
  octoHeatPumpUpdateWaterSetpoint(
    accountNumber: $accountNumber,
    euid: $euid,
    setpoint: $setpoint
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "setpoint": 1
}

{
  "data": {
    "octoHeatPumpUpdateWaterSetpoint": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

pauseCollectionProcess

Type:PauseCollectionProcess

Pause a collection process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11214: Invalid pause length for collection process.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PauseCollectionProcessInput!)

Details for pausing a collection process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessPaused (PauseCollectionProcessOutput)

Collection process pause output.

mutation PauseCollectionProcess($input: PauseCollectionProcessInput!) {
  pauseCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessPaused {
      ...PauseCollectionProcessOutputFragment
    }
  }
}

{
  "input": PauseCollectionProcessInput
}

{
  "data": {
    "pauseCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessPaused": PauseCollectionProcessOutput
    }
  }
}

pauseDunning

Type:PauseDunning

Pause the dunning process for an account.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-11301: Account not in a dunning process for the given path name.
KT-CT-11302: No active dunning process found.
KT-CT-11303: Multiple active dunning processes found.
KT-CT-11304: Dunning pause process failed verifying the dates.
KT-CT-11305: Pausing the dunning process failed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PauseDunningInputType!)

Input variables needed for pausing a dunning process for an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pauseCreated (Boolean)

Whether the pause has been successfully created.

mutation PauseDunning($input: PauseDunningInputType!) {
  pauseDunning(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pauseCreated
  }
}

{
  "input": PauseDunningInputType
}

{
  "data": {
    "pauseDunning": {
      "possibleErrors": [PossibleErrorType],
      "pauseCreated": true
    }
  }
}

payoutReferralForAccount

Type:PayoutReferralForAccount

Pay out a referral reward for an account.

The possible errors that can be raised are:

KT-CT-6712: Invalid reference.
KT-CT-6723: Unauthorized.
KT-CT-6730: Referral cannot be paid out.
KT-CT-6731: The account is unrelated to the referral.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PayoutReferralForAccountInput!)

Input fields for paying out a referral for an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payoutResult (PayoutReferralForAccountResultType)

The result of the payout.

mutation PayoutReferralForAccount($input: PayoutReferralForAccountInput!) {
  payoutReferralForAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payoutResult {
      ...PayoutReferralForAccountResultTypeFragment
    }
  }
}

{
  "input": PayoutReferralForAccountInput
}

{
  "data": {
    "payoutReferralForAccount": {
      "possibleErrors": [PossibleErrorType],
      "payoutResult": PayoutReferralForAccountResultType
    }
  }
}

performMoveOut

Type:PerformMoveOut

Perform a move out of a property for an account.

Optionally provide details of the new tenant and a property to perform a move in to.

The possible errors that can be raised are:

KT-GB-6624: An error occurred when trying to process this house move.
KT-GB-6625: An error occurred when trying to process this house move.
KT-GB-6626: There was an error processing the PSR data.
KT-GB-6627: There are missing agent appointments.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MoveOutInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountInterface)

Account to perform move out.

newAccount (AccountInterface)

The new account created as part of the move out process.

mutation PerformMoveOut($input: MoveOutInput!) {
  performMoveOut(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
    newAccount {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": MoveOutInput
}

{
  "data": {
    "performMoveOut": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface,
      "newAccount": AccountInterface
    }
  }
}

postCredit

Type:PostCredit

Post credit to a ledger.

The possible errors that can be raised are:

KT-CT-5316: Invalid data.
KT-CT-5311: The credit reason with the requested code is deprecated.
KT-CT-5312: The credit reason with the requested code does not exist.
KT-CT-5313: An error occurred whilst posting the credit.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PostCreditInput!)

Input fields for posting a credit.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

credit (Credit)

Posted account credit.

mutation PostCredit($input: PostCreditInput!) {
  postCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    credit {
      ...CreditFragment
    }
  }
}

{
  "input": PostCreditInput
}

{
  "data": {
    "postCredit": {
      "possibleErrors": [PossibleErrorType],
      "credit": Credit
    }
  }
}

postEvPublicChargingAccountCharge

Type:PostEVPublicChargingAccountCharge

Post an account charge for an EV public charging account.

The possible errors that can be raised are:

KT-CT-5813: Invalid data.
KT-CT-5815: Invalid data.
KT-CT-5817: External Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PostEVPublicChargingAccountChargeInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountCharge (AccountChargeType)

Account Charge reference.

mutation PostEvPublicChargingAccountCharge($input: PostEVPublicChargingAccountChargeInput!) {
  postEvPublicChargingAccountCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountCharge {
      ...AccountChargeTypeFragment
    }
  }
}

{
  "input": PostEVPublicChargingAccountChargeInput
}

{
  "data": {
    "postEvPublicChargingAccountCharge": {
      "possibleErrors": [PossibleErrorType],
      "accountCharge": AccountChargeType
    }
  }
}

postEvPublicChargingCharge

Type:PostEVPublicChargingCharge

Post a charge for an EV public charging session.

The possible errors that can be raised are:

KT-CT-5813: Invalid data.
KT-CT-5814: Invalid data.
KT-CT-5815: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PostEVPublicChargingChargeInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountCharge (AccountChargeType)

Charging session charge reference.

mutation PostEvPublicChargingCharge($input: PostEVPublicChargingChargeInput!) {
  postEvPublicChargingCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountCharge {
      ...AccountChargeTypeFragment
    }
  }
}

{
  "input": PostEVPublicChargingChargeInput
}

{
  "data": {
    "postEvPublicChargingCharge": {
      "possibleErrors": [PossibleErrorType],
      "accountCharge": AccountChargeType
    }
  }
}

postEvPublicChargingCredit

Type:PostEVPublicChargingCredit

Post an EV Public Charging credit.

The possible errors that can be raised are:

KT-CT-5815: Invalid data.
KT-CT-5816: Invalid data.
KT-CT-5817: External Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PostEVPublicChargingCreditInput!)

Input fields for creating a credit.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

credit (Credit)

Posts an EV Public charging credit.

mutation PostEvPublicChargingCredit($input: PostEVPublicChargingCreditInput!) {
  postEvPublicChargingCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    credit {
      ...CreditFragment
    }
  }
}

{
  "input": PostEVPublicChargingCreditInput
}

{
  "data": {
    "postEvPublicChargingCredit": {
      "possibleErrors": [PossibleErrorType],
      "credit": Credit
    }
  }
}

prepareAccount

Type:PrepareAccountResult!

Prepare account for sign up. Returns the existing account and/or user if matching datafound for the provided input, otherwise creates a new account and account user.

The possible errors that can be raised are:

KT-CT-10303: Mutation not enabled in this environment.
KT-CT-10316: Input data has invalid format.
KT-CT-10317: An error occured when trying to prepare the account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PrepareAccountInput!)

Return fields

Name	Description

mutation PrepareAccount($input: PrepareAccountInput!) {
  prepareAccount(input: $input) {
    isNewAccount
    accountNumber
    isNewUser
    userId
    userNumber
  }
}

{
  "input": PrepareAccountInput
}

{
  "data": {
    "prepareAccount": {
      "isNewAccount": true,
      "accountNumber": "abc123",
      "isNewUser": true,
      "userId": "abc123",
      "userNumber": "abc123"
    }
  }
}

prerecordConsentGranularity

Type:PrerecordConsentGranularity

Mutation to prerecord reading consent granularity for a meter point.This will not work for MHHS enabled meter points and the setReadingConsentGranularity mutationshould be used instead.

The possible errors that can be raised are:

KT-GB-4501: Meter point not applicable for pre-recording consent.
KT-GB-4502: Unable to determine acceptable granularities. Please try again shortly.
KT-GB-4503: Provided granularity is not valid for this meter point.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReadingConsentGranularityInput!)

Input fields for setting the reading consent granularity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mpan (String)

MPAN for which the mutation was called.

mutation PrerecordConsentGranularity($input: ReadingConsentGranularityInput!) {
  prerecordConsentGranularity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    mpan
  }
}

{
  "input": ReadingConsentGranularityInput
}

{
  "data": {
    "prerecordConsentGranularity": {
      "possibleErrors": [PossibleErrorType],
      "mpan": "abc123"
    }
  }
}

publishApprovalApprovedEvent

Type:PublishApprovalApprovedEvent

Publish an approval approved external event.

The possible errors that can be raised are:

KT-CT-14501: Invalid event parameters.
KT-CT-14502: Invalid input.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PublishApprovalApprovedEventInput!)

Input fields for publishing an approval approved event.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

eventId (ID)

The ID of the created approval approved event.

mutation PublishApprovalApprovedEvent($input: PublishApprovalApprovedEventInput!) {
  publishApprovalApprovedEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    eventId
  }
}

{
  "input": PublishApprovalApprovedEventInput
}

{
  "data": {
    "publishApprovalApprovedEvent": {
      "possibleErrors": [PossibleErrorType],
      "eventId": "abc123"
    }
  }
}

publishTransactionalMessagingExternalTrigger

Type:PublishTransactionalMessagingExternalTrigger

Publish an externally defined transactional messaging trigger.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-5421: Account user not found.
KT-CT-9901: Invalid trigger type code.
KT-CT-9905: Top-level context fields are missing.
KT-CT-9906: Template variables do not match the defined schema.
KT-CT-9908: Invalid recipient information.
KT-CT-9909: Invalid recipient information.
KT-CT-9910: Invalid input field combination.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PublishTransactionalMessagingExternalTriggerInput!)

Input fields to publish an external transactional messaging trigger.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

trigger (Trigger)

The trigger that has been published.

mutation PublishTransactionalMessagingExternalTrigger($input: PublishTransactionalMessagingExternalTriggerInput!) {
  publishTransactionalMessagingExternalTrigger(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    trigger {
      ...TriggerFragment
    }
  }
}

{
  "input": PublishTransactionalMessagingExternalTriggerInput
}

{
  "data": {
    "publishTransactionalMessagingExternalTrigger": {
      "possibleErrors": [PossibleErrorType],
      "trigger": Trigger
    }
  }
}

publishTransactionalMessagingTrigger

Type:PublishTransactionalMessagingTrigger

Publish a trigger within the transactional messaging service.

The possible errors that can be raised are:

KT-CT-9901: Invalid trigger type code.
KT-CT-9902: Invalid trigger type params.
KT-CT-9903: Trigger type cannot be published externally.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (PublishTransactionalMessagingTriggerInput!)

Input fields to publish a transactional messaging trigger.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

trigger (Trigger)

The trigger that has been published.

mutation PublishTransactionalMessagingTrigger($input: PublishTransactionalMessagingTriggerInput!) {
  publishTransactionalMessagingTrigger(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    trigger {
      ...TriggerFragment
    }
  }
}

{
  "input": PublishTransactionalMessagingTriggerInput
}

{
  "data": {
    "publishTransactionalMessagingTrigger": {
      "possibleErrors": [PossibleErrorType],
      "trigger": Trigger
    }
  }
}

purchaseVoucher

Type:PurchaseVoucher

Purchase a voucher.

Arguments

Name Description

input (PurchaseVoucherInput!)

Return fields

Name Description

voucherPurchase (VoucherPurchaseType)

The voucher purchase created from the mutation.

mutation PurchaseVoucher($input: PurchaseVoucherInput!) {
  purchaseVoucher(input: $input) {
    voucherPurchase {
      ...VoucherPurchaseTypeFragment
    }
  }
}

{
  "input": PurchaseVoucherInput
}

{
  "data": {
    "purchaseVoucher": {
      "voucherPurchase": VoucherPurchaseType
    }
  }
}

quoteAccountOnProducts

Type:QuoteAccountOnProducts

Create a quote for an existing account for the specified meterpoints on the passed in products.

The possible errors that can be raised are:

KT-CT-4616: Unable to create a quote.
KT-GB-4614: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (QuoteAccountOnProductsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (QuoteRequest)

The generated quote.

mutation QuoteAccountOnProducts($input: QuoteAccountOnProductsInput!) {
  quoteAccountOnProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteRequestFragment
    }
  }
}

{
  "input": QuoteAccountOnProductsInput
}

{
  "data": {
    "quoteAccountOnProducts": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": QuoteRequest
    }
  }
}

quoteCampaignOffer

Type:QuoteCampaignOffer

Create a quote for a campaign offer.

Arguments

Name Description

input (QuoteCampaignOfferInput)

Return fields

Name Description

quoteCode (String)

mutation QuoteCampaignOffer($input: QuoteCampaignOfferInput) {
  quoteCampaignOffer(input: $input) {
    quoteCode
  }
}

{
  "input": QuoteCampaignOfferInput
}

{
  "data": {
    "quoteCampaignOffer": {
      "quoteCode": "abc123"
    }
  }
}

quoteNewMeterPoints

Type:QuoteNewMeterPoints

Create a quote for new meter points for products with passed in tag.

Arguments

Name Description

input (QuoteNewMeterPointsInput!)

Return fields

Name Description

quoteRequest (QuoteRequest)

The generated quote.

mutation QuoteNewMeterPoints($input: QuoteNewMeterPointsInput!) {
  quoteNewMeterPoints(input: $input) {
    quoteRequest {
      ...QuoteRequestFragment
    }
  }
}

{
  "input": QuoteNewMeterPointsInput
}

{
  "data": {
    "quoteNewMeterPoints": {
      "quoteRequest": QuoteRequest
    }
  }
}

quoteNewMeterPointsOnBespokeProducts

Type:QuoteNewMeterPointsOnBespokeProducts

Create a quote for new meter points on passed in products with bespoke rates. This is an acquisition quote mutation only to be used by authenticated third party organisations for bespoke quoting.

The possible errors that can be raised are:

KT-CT-4616: Unable to create a quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (QuoteNewMeterPointsOnBespokeProductsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (QuoteRequest)

The generated quote.

mutation QuoteNewMeterPointsOnBespokeProducts($input: QuoteNewMeterPointsOnBespokeProductsInput!) {
  quoteNewMeterPointsOnBespokeProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteRequestFragment
    }
  }
}

{
  "input": QuoteNewMeterPointsOnBespokeProductsInput
}

{
  "data": {
    "quoteNewMeterPointsOnBespokeProducts": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": QuoteRequest
    }
  }
}

reactivateCollectionProcessRecord

Type:ReactivateCollectionProcessRecord

Reactivate a Collection Process Record that was previously activated.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11217: Invalid collection process record status for reactivation.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReactivateCollectionProcessRecordInputType!)

Input variables needed for reactivating a collection process record.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessReactivated (ReactivateCollectionProcessRecordOutputType)

The reactivated collection process record.

mutation ReactivateCollectionProcessRecord($input: ReactivateCollectionProcessRecordInputType!) {
  reactivateCollectionProcessRecord(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessReactivated {
      ...ReactivateCollectionProcessRecordOutputTypeFragment
    }
  }
}

{
  "input": ReactivateCollectionProcessRecordInputType
}

{
  "data": {
    "reactivateCollectionProcessRecord": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
    }
  }
}

readDeviceLog

Type:ReadDeviceLog

Send a Read Device Log (SRV 8.9) request for a specified device.

Arguments

Name Description

input (ReadDeviceLogInput!)

Input fields for sending a Read Device Log request.

Return fields

Name Description

requestReference (String)

The reference for the associated request in Kraken.

mutation ReadDeviceLog($input: ReadDeviceLogInput!) {
  readDeviceLog(input: $input) {
    requestReference
  }
}

{
  "input": ReadDeviceLogInput
}

{
  "data": {
    "readDeviceLog": {
      "requestReference": "abc123"
    }
  }
}

readInventory

Type:ReadInventory

Triggers a Read Inventory request to be sent through the DCC adapter for either a given device EUI64 or MPxN.

The possible errors that can be raised are:

KT-GB-4021: Invalid MPxN.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReadInventoryInput!)

Input field for a read inventory via device EUI64 or MPAN/MPRN.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference for the associated request in Kraken.

mutation ReadInventory($input: ReadInventoryInput!) {
  readInventory(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": ReadInventoryInput
}

{
  "data": {
    "readInventory": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

recordDepositAgreementAccepted

Type:RecordDepositAgreementAccepted

Record the customer's acceptance of a deposit agreement.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DepositAgreementInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

isRecorded (Boolean)

mutation RecordDepositAgreementAccepted($input: DepositAgreementInput!) {
  recordDepositAgreementAccepted(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    isRecorded
  }
}

{
  "input": DepositAgreementInput
}

{
  "data": {
    "recordDepositAgreementAccepted": {
      "possibleErrors": [PossibleErrorType],
      "isRecorded": true
    }
  }
}

recordFailedPayment

Type:RecordFailedPayment

Record one or more failed payments.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
KT-CT-3985: Received both token and options for action intent.
KT-CT-3986: Received neither token nor options for action intent.
KT-CT-3987: Invalid payment method type code.
KT-CT-3988: Number of items in list exceeds maximum value.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RecordFailedPaymentInput!)

Details about the failed payments.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

mutation RecordFailedPayment($input: RecordFailedPaymentInput!) {
  recordFailedPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    noticeBatchIdentifier
  }
}

{
  "input": RecordFailedPaymentInput
}

{
  "data": {
    "recordFailedPayment": {
      "possibleErrors": [PossibleErrorType],
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordPendingPayment

Type:RecordPendingPayment

Record one or more pending payments.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
KT-CT-3985: Received both token and options for action intent.
KT-CT-3986: Received neither token nor options for action intent.
KT-CT-3987: Invalid payment method type code.
KT-CT-3988: Number of items in list exceeds maximum value.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RecordPendingPaymentInput!)

Details about the pending payments.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

mutation RecordPendingPayment($input: RecordPendingPaymentInput!) {
  recordPendingPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    noticeBatchIdentifier
  }
}

{
  "input": RecordPendingPaymentInput
}

{
  "data": {
    "recordPendingPayment": {
      "possibleErrors": [PossibleErrorType],
      "noticeBatchIdentifier": "abc123"
    }
  }
}

recordSuccessfulPayment

Type:RecordSuccessfulPayment

Record one or more successful payments.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
KT-CT-3985: Received both token and options for action intent.
KT-CT-3986: Received neither token nor options for action intent.
KT-CT-3987: Invalid payment method type code.
KT-CT-3988: Number of items in list exceeds maximum value.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RecordSuccessfulPaymentInput!)

Details about the successful payments.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

mutation RecordSuccessfulPayment($input: RecordSuccessfulPaymentInput!) {
  recordSuccessfulPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    noticeBatchIdentifier
  }
}

{
  "input": RecordSuccessfulPaymentInput
}

{
  "data": {
    "recordSuccessfulPayment": {
      "possibleErrors": [PossibleErrorType],
      "noticeBatchIdentifier": "abc123"
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type:RedeemLoyaltyPointsForAccountCredit

Redeem the passed number of Loyalty Points as account credit.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9201: No Loyalty Point ledger found for the user.
KT-CT-9202: Loyalty Points adapter not configured.
KT-CT-9203: No ledger entries for the ledger.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9206: Indivisible points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsRedeemed (Int)

The number of loyalty points that were redeemed.

mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
  redeemLoyaltyPointsForAccountCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsRedeemed
  }
}

{
  "input": RedeemLoyaltyPointsInput
}

{
  "data": {
    "redeemLoyaltyPointsForAccountCredit": {
      "possibleErrors": [PossibleErrorType],
      "pointsRedeemed": 1
    }
  }
}

redeemReferralClaimCode

Type:RedeemReferralClaimCode

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6724: Referral claim code not found.
KT-CT-6725: Referral claim code redeeming error.
KT-CT-6726: Referral claim code has already been redeemed.
KT-CT-6727: Referral claim code is not available.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RedeemReferralClaimCodeInput!)

Input fields for redeeming referral code.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether or not the request was successful.

mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
  redeemReferralClaimCode(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RedeemReferralClaimCodeInput
}

{
  "data": {
    "redeemReferralClaimCode": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

refreshQuote

Type:RefreshQuote

Refresh quote with updated products for a quote code.

The possible errors that can be raised are:

KT-GB-4612: Unable to refresh quote - quote not found.
KT-GB-4613: Error generating quote.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RefreshQuoteInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quote (QuoteType)

mutation RefreshQuote($input: RefreshQuoteInput!) {
  refreshQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quote {
      ...QuoteTypeFragment
    }
  }
}

{
  "input": RefreshQuoteInput
}

{
  "data": {
    "refreshQuote": {
      "possibleErrors": [PossibleErrorType],
      "quote": QuoteType
    }
  }
}

refreshQuoteV2

Type:RefreshQuoteV2

Refresh an existing quote with the currently available products.

The possible errors that can be raised are:

KT-GB-4618: Quote request not found.
KT-CT-12901: Account not found.
KT-CT-12004: Invalid product tag type.
KT-GB-4627: Input to the refresh quote mutation is invalid.
KT-GB-4628: No available products found for this quote input.
KT-GB-4629: Failed to refresh quote.
KT-CT-4616: Unable to create a quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RefreshQuoteV2Input!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

quoteRequest (QuoteRequest)

The generated quote.

mutation RefreshQuoteV2($input: RefreshQuoteV2Input!) {
  refreshQuoteV2(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    quoteRequest {
      ...QuoteRequestFragment
    }
  }
}

{
  "input": RefreshQuoteV2Input
}

{
  "data": {
    "refreshQuoteV2": {
      "possibleErrors": [PossibleErrorType],
      "quoteRequest": QuoteRequest
    }
  }
}

refundPayment

Type:RefundPayment

Refund a cleared payment.

The possible errors that can be raised are:

KT-CT-3924: Unauthorized.
KT-CT-3928: Idempotency key used for another repayment request.
KT-CT-3929: The payment is not in a refundable state.
KT-CT-3933: Refund amount greater than payment amount.
KT-CT-3937: Payment not eligible for refund.
KT-CT-3938: Partial refund not allowed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RefundPaymentInput!)

Input fields for refunding a payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repayment (AccountRepaymentType)

The repayment for the requested refund.

mutation RefundPayment($input: RefundPaymentInput!) {
  refundPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repayment {
      ...AccountRepaymentTypeFragment
    }
  }
}

{
  "input": RefundPaymentInput
}

{
  "data": {
    "refundPayment": {
      "possibleErrors": [PossibleErrorType],
      "repayment": AccountRepaymentType
    }
  }
}

regenerateSecretKey

Type:RegenerateSecretKey

Regenerate the live secret key for the authenticated user.

Return fields

Name Description

key (String!)

The generated key value, which is only ever available once (here).

viewer (AccountUserType)

The currently authenticated user.

mutation RegenerateSecretKey {
  regenerateSecretKey {
    key
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "data": {
    "regenerateSecretKey": {
      "key": "abc123",
      "viewer": AccountUserType
    }
  }
}

registerCustomerAsset

Type:RegisterCustomerAsset

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-14602: Customer asset already exists.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RegisterCustomerAssetInput!)

Input fields for registering a device.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

customerAsset (CustomerAssetType)

The registered customer asset.

mutation RegisterCustomerAsset($input: RegisterCustomerAssetInput!) {
  registerCustomerAsset(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerAsset {
      ...CustomerAssetTypeFragment
    }
  }
}

{
  "input": RegisterCustomerAssetInput
}

{
  "data": {
    "registerCustomerAsset": {
      "possibleErrors": [PossibleErrorType],
      "customerAsset": CustomerAssetType
    }
  }
}

registerLeadFlowStatusEvent

Type:RegisterLeadFlowStatusEvent

The possible errors that can be raised are:

KT-CT-8907: Lead not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RegisterLeadFlowStatusEventInput!)

Input fields for registering a flow status event for a Lead.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation RegisterLeadFlowStatusEvent($input: RegisterLeadFlowStatusEventInput!) {
  registerLeadFlowStatusEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": RegisterLeadFlowStatusEventInput
}

{
  "data": {
    "registerLeadFlowStatusEvent": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

registerOpportunityFlowStatusEvent

Type:RegisterOpportunityFlowStatusEvent

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RegisterOpportunityFlowStatusEventInput!)

Input fields for registering a flow status event for a opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation RegisterOpportunityFlowStatusEvent($input: RegisterOpportunityFlowStatusEventInput!) {
  registerOpportunityFlowStatusEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": RegisterOpportunityFlowStatusEventInput
}

{
  "data": {
    "registerOpportunityFlowStatusEvent": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

registerPushNotificationBinding

Type:RegisterPushNotificationBinding

This field requires the Authorization header to be set.

Arguments

Name Description

input (RegisterPushNotificationBindingInput!)

Input fields for creating an push notification binding.

Return fields

Name Description

pushNotificationBinding (PushNotificationBindingType)

mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
  registerPushNotificationBinding(input: $input) {
    pushNotificationBinding {
      ...PushNotificationBindingTypeFragment
    }
  }
}

{
  "input": RegisterPushNotificationBindingInput
}

{
  "data": {
    "registerPushNotificationBinding": {
      "pushNotificationBinding": PushNotificationBindingType
    }
  }
}

registerSmartDevice

Type:RegisterSmartDevice

Notify Kraken to run the relevant prenotifications for a new device.

Arguments

Name Description

input (RegisterSmartDeviceInput!)

Specifies device metadata to use for prenotifications.

Return fields

Name Description

requestReference (String)

The reference for the associated request in Kraken.

mutation RegisterSmartDevice($input: RegisterSmartDeviceInput!) {
  registerSmartDevice(input: $input) {
    requestReference
  }
}

{
  "input": RegisterSmartDeviceInput
}

{
  "data": {
    "registerSmartDevice": {
      "requestReference": "abc123"
    }
  }
}

removeCampaignFromAccount

Type:RemoveCampaignFromAccount

The possible errors that can be raised are:

KT-CT-7424: Failed to remove campaign from account.
KT-CT-7426: The account is not part of the given campaign.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RemoveCampaignFromAccountInput!)

Input variables needed for removing a campaign from an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignRemoved (Boolean)

Whether the campaign was successfully removed from the account.

mutation RemoveCampaignFromAccount($input: RemoveCampaignFromAccountInput!) {
  removeCampaignFromAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignRemoved
  }
}

{
  "input": RemoveCampaignFromAccountInput
}

{
  "data": {
    "removeCampaignFromAccount": {
      "possibleErrors": [PossibleErrorType],
      "campaignRemoved": true
    }
  }
}

removeCampaignItems

Type:RemoveCampaignItems

The possible errors that can be raised are:

KT-CT-11501: Voice campaign not found.
KT-CT-11502: Cannot remove items from multiple campaigns at once.
KT-CT-11505: Voice campaign item not found.
KT-CT-11506: Invalid campaign ID.
KT-CT-11507: Invalid campaign item ID.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RemoveCampaignItemsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignItems ([VoiceCampaignItemType])

mutation RemoveCampaignItems($input: RemoveCampaignItemsInput!) {
  removeCampaignItems(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignItems {
      ...VoiceCampaignItemTypeFragment
    }
  }
}

{
  "input": RemoveCampaignItemsInput
}

{
  "data": {
    "removeCampaignItems": {
      "possibleErrors": [PossibleErrorType],
      "campaignItems": [VoiceCampaignItemType]
    }
  }
}

removeConsumerDevice

Type:RemoveConsumerDevice

Triggers the orchestration to remove the CAD device to the ESME, GSME, GPF and CHF.

The possible errors that can be raised are:

KT-GB-4012: Unable to find the CAD device.
KT-GB-4032: Error sending the request to remove the device.
KT-GB-4013: Received invalid device type to remove other than CAD.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RemoveConsumerDeviceInput!)

Input fields for remove device.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference of the remove consumer device request in Kraken.

mutation RemoveConsumerDevice($input: RemoveConsumerDeviceInput!) {
  removeConsumerDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": RemoveConsumerDeviceInput
}

{
  "data": {
    "removeConsumerDevice": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

removeItemsFromRiskList

Type:RemoveItemsFromRiskList

Remove items from the risk list.

The possible errors that can be raised are:

KT-CT-12106: Risk list item removal failed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input ([RiskListItemInputType]!)

A list of risk list items to remove.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

riskIdentifiers ([RiskListItemType])

List of successfully removed risk identifiers.

mutation RemoveItemsFromRiskList($input: [RiskListItemInputType]!) {
  removeItemsFromRiskList(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    riskIdentifiers {
      ...RiskListItemTypeFragment
    }
  }
}

{
  "input": RiskListItemInputType
}

{
  "data": {
    "removeItemsFromRiskList": {
      "possibleErrors": [PossibleErrorType],
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

removePropertyFromHierarchy

Type:RemovePropertyFromHierarchy

Remove a property from a hierarchy.

This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.

The possible errors that can be raised are:

KT-CT-6622: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RemovePropertyFromHierarchyInput!)

Input fields for removing a property from a hierarchy.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

property (PropertyType)

The property that was removed from the hierarchy.

mutation RemovePropertyFromHierarchy($input: RemovePropertyFromHierarchyInput!) {
  removePropertyFromHierarchy(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    property {
      ...PropertyTypeFragment
    }
  }
}

{
  "input": RemovePropertyFromHierarchyInput
}

{
  "data": {
    "removePropertyFromHierarchy": {
      "possibleErrors": [PossibleErrorType],
      "property": PropertyType
    }
  }
}

removeSensor

Type:RemoveSensor

Remove a sensor from a heating controller device.

The possible errors that can be raised are:

KT-CT-4309: Error trying to remove sensor from heat pump controller.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

sensorId (String!)

The sensor ID of heat pump controller's sensor to be removed.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with removing a sensor from a heat pump controller.

mutation RemoveSensor(
  $accountNumber: String!,
  $euid: ID!,
  $sensorId: String!
) {
  removeSensor(
    accountNumber: $accountNumber,
    euid: $euid,
    sensorId: $sensorId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "sensorId": "abc123"
}

{
  "data": {
    "removeSensor": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

renewAgreementForMeterPoint

Type:RenewAgreementForMeterPoint

Renew agreement for a meter point.

The possible errors that can be raised are:

KT-GB-4112: Unable to renew agreements for meter point at this time. Please try again later.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RenewAgreementForMeterPointInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

electricityAgreement (RestrictedElectricityAgreement)

gasAgreement (RestrictedGasAgreement)

mutation RenewAgreementForMeterPoint($input: RenewAgreementForMeterPointInput!) {
  renewAgreementForMeterPoint(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    electricityAgreement {
      ...RestrictedElectricityAgreementFragment
    }
    gasAgreement {
      ...RestrictedGasAgreementFragment
    }
  }
}

{
  "input": RenewAgreementForMeterPointInput
}

{
  "data": {
    "renewAgreementForMeterPoint": {
      "possibleErrors": [PossibleErrorType],
      "electricityAgreement": RestrictedElectricityAgreement,
      "gasAgreement": RestrictedGasAgreement
    }
  }
}

renewAgreements

Type:RenewAgreements

Renew agreements for an account.

The possible errors that can be raised are:

KT-GB-4125: Invalid data.
KT-GB-4111: Unable to renew agreements for tariff renewal.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RenewAgreementsInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

mutation RenewAgreements($input: RenewAgreementsInput) {
  renewAgreements(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": RenewAgreementsInput
}

{
  "data": {
    "renewAgreements": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

renewAgreementsForAccount

Type:RenewAgreementsForAccount

Renew a list of agreements for an account.

The possible errors that can be raised are:

KT-GB-4113: At least one list of agreements to renew is required.
KT-GB-4126: Electricity and gas agreement input is invalid.
KT-GB-4114: Unable to renew agreements.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RenewAgreementsForAccountInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

mutation RenewAgreementsForAccount($input: RenewAgreementsForAccountInput) {
  renewAgreementsForAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": RenewAgreementsForAccountInput
}

{
  "data": {
    "renewAgreementsForAccount": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

replaceAgreement

Type:ReplaceAgreement

Replace an agreement for an account with a new product.

Arguments

Name Description

input (ReplaceAgreementInput)

Return fields

Name Description

account (AccountInterface)

mutation ReplaceAgreement($input: ReplaceAgreementInput) {
  replaceAgreement(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": ReplaceAgreementInput
}

{
  "data": {
    "replaceAgreement": {
      "account": AccountInterface
    }
  }
}

replaceCommsHub

Type:ReplaceCommsHub

Replace an existing Communications Hub with a new one and move existing devices to the new Hub.

Arguments

Name Description

input (ReplaceCommsHubInput!)

Input fields for replacing a Communications Hub.

Return fields

Name Description

requestReference (String)

The reference for the associated request in Kraken.

mutation ReplaceCommsHub($input: ReplaceCommsHubInput!) {
  replaceCommsHub(input: $input) {
    requestReference
  }
}

{
  "input": ReplaceCommsHubInput
}

{
  "data": {
    "replaceCommsHub": {
      "requestReference": "abc123"
    }
  }
}

reportRemovedMeterDetails

Type:ReportRemovedMeterDetails

Report details, readings and balances of meters removed during install.

The possible errors that can be raised are:

KT-GB-4213: Application not found.
KT-GB-4231: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReportRemovedMeterDetailsInput!)

Input fields for removed meter details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

result (ReportRemovedMeterDetailsOutput)

mutation ReportRemovedMeterDetails($input: ReportRemovedMeterDetailsInput!) {
  reportRemovedMeterDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    result {
      ...ReportRemovedMeterDetailsOutputFragment
    }
  }
}

{
  "input": ReportRemovedMeterDetailsInput
}

{
  "data": {
    "reportRemovedMeterDetails": {
      "possibleErrors": [PossibleErrorType],
      "result": ReportRemovedMeterDetailsOutput
    }
  }
}

requestConsumptionData

Type:RequestConsumptionData

Request an ad hoc read of the meters consumption data, which will arrive asynchronously

The possible errors that can be raised are:

KT-GB-4033: No electricity device found matching device ID.
KT-GB-4034: Error requesting consumption data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestConsumptionDataInput!)

Input fields for requesting consumption data.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference for the associated request in Kraken.

mutation RequestConsumptionData($input: RequestConsumptionDataInput!) {
  requestConsumptionData(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": RequestConsumptionDataInput
}

{
  "data": {
    "requestConsumptionData": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

requestDoubleOptIn

Type:RequestDoubleOptIn

Request a double opt in

The possible errors that can be raised are:

KT-CT-9019: Invalid input.
KT-CT-9018: Account not found.
KT-CT-1111: Unauthorized.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-9023: Consent already accepted.
KT-CT-1199: Too many requests.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DoubleOptInInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consent (ConsentType)

The consent that was created or updated.

mutation RequestDoubleOptIn($input: DoubleOptInInput) {
  requestDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

{
  "input": DoubleOptInInput
}

{
  "data": {
    "requestDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

requestPasswordReset

Type:RequestPasswordResetOutputType

Provide the email address of an account user to send them an email with instructions on how to reset their password.

The possible errors that can be raised are:

KT-CT-11331: Invalid input data.
KT-CT-11332: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

Name Description

email (String)

The email that requested a password reset email.

userNumber (String)

The number of the user that requested a password reset email.

mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
  requestPasswordReset(input: $input) {
    email
    userNumber
  }
}

{
  "input": RequestPasswordResetInput
}

{
  "data": {
    "requestPasswordReset": {
      "email": "abc123",
      "userNumber": "abc123"
    }
  }
}

requestPrintedBill

Type:RequestPrintedBill

Request an issued bill to be printed and (re)posted to billing address of the account.

The possible errors that can be raised are:

KT-CT-3824: Unauthorized.
KT-CT-9705: The billing document has not been issued.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestPrintedBillInput!)

Input fields to request a printed bill.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Whether the request was successful.

mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
  requestPrintedBill(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RequestPrintedBillInput
}

{
  "data": {
    "requestPrintedBill": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

requestProvisioningClaimCertificate

Type:RequestProvisioningClaimCertificate

Request a certificate to provision a heating controller.

The possible errors that can be raised are:

KT-CT-4332: Invalid data.
KT-CT-4304: Error in preprovisioning step for Octopus Heat Pump.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

propertyId (ID)

The primary key of a property you would like to associate with this controller.

requestParameters (ProvisioningClaimRequestParameters!)

Parameters requested by the app from the controller, required for Kraken Flex to authenticate the device.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

provisioningClaimBundle (ProvisioningClaimBundle)

The certificate and private key required to create a provisioning claim.

mutation RequestProvisioningClaimCertificate(
  $accountNumber: String!,
  $propertyId: ID,
  $requestParameters: ProvisioningClaimRequestParameters!
) {
  requestProvisioningClaimCertificate(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    requestParameters: $requestParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    provisioningClaimBundle {
      ...ProvisioningClaimBundleFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "propertyId": "abc123",
  "requestParameters": ProvisioningClaimRequestParameters
}

{
  "data": {
    "requestProvisioningClaimCertificate": {
      "possibleErrors": [PossibleErrorType],
      "provisioningClaimBundle": ProvisioningClaimBundle
    }
  }
}

requote

Type:Requote

Requote for an account property.

Arguments

Name Description

input (RequoteInput!)

Return fields

Name Description

quote (QuoteType)

The requoted quote.

mutation Requote($input: RequoteInput!) {
  requote(input: $input) {
    quote {
      ...QuoteTypeFragment
    }
  }
}

{
  "input": RequoteInput
}

{
  "data": {
    "requote": {
      "quote": QuoteType
    }
  }
}

resetPassword

Type:ResetPasswordMutationPayload

Reset the password of an account user indicated by the userId to the value supplied.

Deprecated

The 'resetPassword' field is deprecated.

Please use `resetUserPassword` instead.

- Marked as deprecated on 2024-12-04.
- Scheduled for removal on or after 2025-06-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/81/

Arguments

Name Description

input (ResetPasswordMutationInput!)

Return fields

Name Description

errors ([SerializerFieldErrorsType])

clientMutationId (String)

mutation ResetPassword($input: ResetPasswordMutationInput!) {
  resetPassword(input: $input) {
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
    clientMutationId
  }
}

{
  "input": ResetPasswordMutationInput
}

{
  "data": {
    "resetPassword": {
      "errors": [SerializerFieldErrorsType],
      "clientMutationId": "abc123"
    }
  }
}

resetUserPassword

Type:ResetUserPasswordOutput

Reset the password of an account user.

Raises KT-CT-5450 if password validation fails. Inspect the validationErrors extension to get the exact validation error:

json { "data": {"resetUserPassword": null}, "errors": [ { "message": "Password is invalid.", "path": ["resetUserPassword"], "extensions": { "errorType": "VALIDATION", "errorCode": "KT-CT-5450", "errorDescription": "Given password fails password policy requirements.", "validationErrors": [ { "code": "password_too_short", "message": "This password is too short. It must contain at least 7 characters.", "inputPath": ["input", "password"] }, { "code": "password_too_common", "message": "This password is too common.", "inputPath": ["input", "password"] } ] } } ] }

The validation error's code can be any of - password_too_short - password_too_common - password_reused - password_matches_current - password_has_too_few_numeric_characters - password_has_too_few_special_characters - password_has_too_few_lowercase_characters - password_has_too_few_uppercase_characters - password_contains_account_number - password_contains_part_of_email_address

The possible errors that can be raised are:

KT-CT-4125: Unauthorized.
KT-CT-1132: Unauthorized.
KT-CT-5450: Password is invalid.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

Name	Description
`userId` (`ID!`)	The ID of the user whose password was changed.
`passwordUpdated` (`Boolean`)	True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. Please handle the KT-CT-5450 error instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`failureReasons` (`[String]`)	A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].message` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`failureCodes` (`[String]`)	A list of codes of which password validation the new password failed against if applicable. One of: - `password_too_short` - `password_too_common` - `password_reused` - `password_matches_current` - `password_has_too_few_numeric_characters` - `password_has_too_few_special_characters` - `password_has_too_few_lowercase_characters` - `password_has_too_few_uppercase_characters` - `password_contains_account_number` - `password_contains_part_of_email_address` Deprecated The 'failureCodes' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].code` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.

mutation ResetUserPassword($input: ResetUserPasswordInput!) {
  resetUserPassword(input: $input) {
    userId
    passwordUpdated
    failureReasons
    failureCodes
  }
}

{
  "input": ResetUserPasswordInput
}

{
  "data": {
    "resetUserPassword": {
      "userId": "abc123",
      "passwordUpdated": true,
      "failureReasons": ["abc123"],
      "failureCodes": ["abc123"]
    }
  }
}

resumeCollectionProcess

Type:ResumeCollectionProcess

Resume a collection process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11215: Unable to resume, collection process is not paused.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ResumeCollectionProcessInput!)

Details for resuming a collection process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessResumed (ResumeCollectionProcessOutput)

Collection process resume output.

mutation ResumeCollectionProcess($input: ResumeCollectionProcessInput!) {
  resumeCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessResumed {
      ...ResumeCollectionProcessOutputFragment
    }
  }
}

{
  "input": ResumeCollectionProcessInput
}

{
  "data": {
    "resumeCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessResumed": ResumeCollectionProcessOutput
    }
  }
}

resumeControl

Type:ResumeDeviceControl

Resume control of the device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4359: Unable to resume device control.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'resumeControl' field is deprecated.

Please use 'updateDeviceSmartControl' instead.

- Marked as deprecated on 2024-09-17.
- Scheduled for removal on or after 2025-12-11.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/468/

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation ResumeControl($input: AccountNumberInput) {
  resumeControl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "resumeControl": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

retrieveLatestWanCoverage

Type:RetrieveLatestWANCoverage

Retrieve WAN matrices.

Arguments

Name Description

input (RetrieveLatestWANCoverageInput!)

Input field for a retrieve latest WAN coverage request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference for the associated request in Kraken.

mutation RetrieveLatestWanCoverage($input: RetrieveLatestWANCoverageInput!) {
  retrieveLatestWanCoverage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": RetrieveLatestWANCoverageInput
}

{
  "data": {
    "retrieveLatestWanCoverage": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

reverseEnrollment

Type:EnrollmentReversed!

Reverse an enrollment (Join Supplier process).

The possible errors that can be raised are:

KT-CT-10312: Mutation not enabled in this environment.
KT-CT-10318: Enrollment process not found.
KT-CT-10349: Enrollment process is not reversible.
KT-CT-10350: Enrollment process can still be cancelled.
KT-CT-10351: Enrollment process being cancelled cannot be reversed.
KT-CT-10352: Market actions cannot be reversed for this enrollment process.
KT-CT-10353: Failed to reverse enrollment process.
KT-CT-10354: Enrollment reversal cut-off has passed.
KT-CT-10355: Enrollment reversal is not allowed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReverseEnrollmentInput!)

The input required to reverse an enrollment.

Return fields

Name	Description

mutation ReverseEnrollment($input: ReverseEnrollmentInput!) {
  reverseEnrollment(input: $input) {
    message
    enrollmentProcess {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
  }
}

{
  "input": ReverseEnrollmentInput
}

{
  "data": {
    "reverseEnrollment": {
      "message": "abc123",
      "enrollmentProcess": JoinSupplierProcessType
    }
  }
}

reverseLeaveSupplier

Type:LeaveSupplierReversed!

Reverse a leave supplier process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-10302: Invalid data.
KT-CT-10341: Leave supplier process is not reversible.
KT-CT-10342: Leave supplier process can still be cancelled.
KT-CT-10343: Leave supplier process being cancelled cannot be reversed.
KT-CT-10344: Leave supplier reversal cut-off has passed.
KT-CT-10345: Occupier leave with real join cannot be reversed.
KT-CT-10346: Market action reversal is not supported for this leave supplier process.
KT-CT-10347: Failed to reverse leave supplier process.
KT-CT-10348: Leave supplier reversal is missing required dependencies.
KT-CT-1607: Value cannot be empty.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ReverseLeaveSupplierInput!)

Return fields

Name	Description

mutation ReverseLeaveSupplier($input: ReverseLeaveSupplierInput!) {
  reverseLeaveSupplier(input: $input) {
    message
  }
}

{
  "input": ReverseLeaveSupplierInput
}

{
  "data": {
    "reverseLeaveSupplier": {
      "message": "abc123"
    }
  }
}

revokeAgreement

Type:RevokeAgreement

Revoke an agreement.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-1501: Agreement not found.
KT-CT-1502: Billed agreements cannot be revoked.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RevokeAgreementInput!)

Input fields for revoking an agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

Account responsible for the revoked agreement.

mutation RevokeAgreement($input: RevokeAgreementInput!) {
  revokeAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": RevokeAgreementInput
}

{
  "data": {
    "revokeAgreement": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

revokeContract

Type:RevokeContractOutput!

Revoke an existing contract.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10022: Contract already terminated.
KT-CT-10023: Contract is already revoked.
KT-CT-10024: Contract already expired.
KT-CT-10032: Contract has already started.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RevokeContractInput!)

Return fields

Name	Description

mutation RevokeContract($input: RevokeContractInput!) {
  revokeContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

{
  "input": RevokeContractInput
}

{
  "data": {
    "revokeContract": {
      "contract": Contract
    }
  }
}

revokeUserAccessFromBusiness

Type:RevokeUserAccessFromBusiness

Revoke the selected role from the user for the business.

The possible errors that can be raised are:

KT-CT-5463: Unauthorized.
KT-CT-11107: Unauthorized.
KT-CT-13501: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RevokeUserAccessFromBusinessInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation RevokeUserAccessFromBusiness($input: RevokeUserAccessFromBusinessInput!) {
  revokeUserAccessFromBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": RevokeUserAccessFromBusinessInput
}

{
  "data": {
    "revokeUserAccessFromBusiness": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

runAgreementRollover

Type:RunAgreementRollover

Run an agreement rollover.

The possible errors that can be raised are:

KT-CT-13705: Agreement rollover not found.
KT-CT-13706: Agreement rollover has an invalid status for this operation.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RunAgreementRolloverInput!)

Input for running an agreement rollover.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreementRollover (AgreementRolloverType)

The executed agreement rollover.

mutation RunAgreementRollover($input: RunAgreementRolloverInput!) {
  runAgreementRollover(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

{
  "input": RunAgreementRolloverInput
}

{
  "data": {
    "runAgreementRollover": {
      "possibleErrors": [PossibleErrorType],
      "agreementRollover": AgreementRolloverType
    }
  }
}

scheduleQuoteFollowUp

Type:ScheduleQuoteFollowUp

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4632: Invalid recipient information.
KT-CT-4633: Mutation not enabled in this environment.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether the message was scheduled successfully.

mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
  scheduleQuoteFollowUp(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": QuoteShareInput
}

{
  "data": {
    "scheduleQuoteFollowUp": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

selectChargePointMakeForSmartFlexOnboarding

Type:SelectChargePointMakeForSmartFlexOnboarding

Select the charge point make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectChargePointMakeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectChargePointMakeInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectChargePointMakeForSmartFlexOnboarding($input: SelectChargePointMakeInput!) {
  selectChargePointMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectChargePointMakeInput
}

{
  "data": {
    "selectChargePointMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectChargePointVariantForSmartFlexOnboarding

Type:SelectChargePointVariantForSmartFlexOnboarding

Select the charge point model variant to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectChargePointVariantForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectChargePointVariantInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectChargePointVariantForSmartFlexOnboarding($input: SelectChargePointVariantInput!) {
  selectChargePointVariantForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectChargePointVariantInput
}

{
  "data": {
    "selectChargePointVariantForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectDeviceTypeForSmartFlexOnboarding

Type:SelectDeviceTypeForSmartFlexOnboarding

Select the device type to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectDeviceTypeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectDeviceTypeInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectDeviceTypeForSmartFlexOnboarding($input: SelectDeviceTypeInput!) {
  selectDeviceTypeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectDeviceTypeInput
}

{
  "data": {
    "selectDeviceTypeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectFromListForSmartFlexOnboarding

Type:SelectFromListForSmartFlexOnboarding

Select from a list of options presented.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectFromListInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectFromListForSmartFlexOnboarding($input: SelectFromListInput!) {
  selectFromListForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectFromListInput
}

{
  "data": {
    "selectFromListForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectHeatPumpMakeForSmartFlexOnboarding

Type:SelectHeatPumpMakeForSmartFlexOnboarding

Select the heat pump make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectHeatPumpMakeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectHeatPumpMakeInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectHeatPumpMakeForSmartFlexOnboarding($input: SelectHeatPumpMakeInput!) {
  selectHeatPumpMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectHeatPumpMakeInput
}

{
  "data": {
    "selectHeatPumpMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectInverterMakeForSmartFlexOnboarding

Type:SelectInverterMakeForSmartFlexOnboarding

Select the inverter make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectInverterMakeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectInverterMakeInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectInverterMakeForSmartFlexOnboarding($input: SelectInverterMakeInput!) {
  selectInverterMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectInverterMakeInput
}

{
  "data": {
    "selectInverterMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectProducts

Type:SelectProducts

Mark quoted products on a quote request as selected.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4634: Quoted product with given id not found.
KT-CT-4626: No product selected for the given quote code.
KT-CT-4635: Missing a quoted product for at least one quoted supply point on the quote request.
KT-CT-4636: Quoted product not linked to a product.
KT-CT-4646: Attempted to select multiple products for the same quoted supply point.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectProductsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether we successfully marked the chosen quoted products as selected.

mutation SelectProducts($input: SelectProductsInput!) {
  selectProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": SelectProductsInput
}

{
  "data": {
    "selectProducts": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

selectUserVehicleForSmartFlexOnboarding

Type:SelectUserVehicleForSmartFlexOnboarding

Select the user's vehicle to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectUserVehicleForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectUserVehicleInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectUserVehicleForSmartFlexOnboarding($input: SelectUserVehicleInput!) {
  selectUserVehicleForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectUserVehicleInput
}

{
  "data": {
    "selectUserVehicleForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleMakeForSmartFlexOnboarding

Type:SelectVehicleMakeForSmartFlexOnboarding

Select the vehicle make to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectVehicleMakeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectVehicleMakeInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectVehicleMakeForSmartFlexOnboarding($input: SelectVehicleMakeInput!) {
  selectVehicleMakeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectVehicleMakeInput
}

{
  "data": {
    "selectVehicleMakeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleOrChargePointForSmartFlexOnboarding

Type:CompleteSelectVehicleOrChargePointForSmartFlexOnboarding

Select the vehicle or charge point for the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SelectVehicleOrChargePointInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectVehicleOrChargePointForSmartFlexOnboarding($input: SelectVehicleOrChargePointInput!) {
  selectVehicleOrChargePointForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectVehicleOrChargePointInput
}

{
  "data": {
    "selectVehicleOrChargePointForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleVariantForSmartFlexOnboarding

Type:SelectVehicleVariantForSmartFlexOnboarding

Select the vehicle model variant to proceed in the onboarding journey.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectVehicleVariantForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (SelectVehicleVariantInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation SelectVehicleVariantForSmartFlexOnboarding($input: SelectVehicleVariantInput!) {
  selectVehicleVariantForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": SelectVehicleVariantInput
}

{
  "data": {
    "selectVehicleVariantForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

sendDecommissionRequest

Type:SendDecommissionRequest

Decommission a device (Single request / 8.3).

Arguments

Name Description

input (SendDecommissionRequestInput!)

Input fields for decommission devices.

Return fields

Name Description

requestReference (String)

The reference of the Decommission Request in Kraken.

mutation SendDecommissionRequest($input: SendDecommissionRequestInput!) {
  sendDecommissionRequest(input: $input) {
    requestReference
  }
}

{
  "input": SendDecommissionRequestInput
}

{
  "data": {
    "sendDecommissionRequest": {
      "requestReference": "abc123"
    }
  }
}

sendGbrQuoteSummary

Type:SendGBRQuoteSummary

Send a quote summary to the customer for the specified products.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4632: Invalid recipient information.
KT-CT-4634: Quoted product with given id not found.
KT-CT-4616: Unable to create a quote.
KT-CT-9402: Received an invalid brandCode.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GBRQuoteShareInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether the triggering of the quote summary was successful.

mutation SendGbrQuoteSummary($input: GBRQuoteShareInput!) {
  sendGbrQuoteSummary(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": GBRQuoteShareInput
}

{
  "data": {
    "sendGbrQuoteSummary": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

sendLossObjectionForChangeOfSupplier

Type:SendLossObjectionForChangeOfSupplier

Send an objection to an ongoing change of supplier process in order to try and cancel it.

The possible errors that can be raised are:

KT-CT-4185: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SendLossObjectionForChangeOfSupplierInput!)

Input fields for sending loss objection for change of supplier.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Returns true if objection was successfully sent.

mutation SendLossObjectionForChangeOfSupplier($input: SendLossObjectionForChangeOfSupplierInput!) {
  sendLossObjectionForChangeOfSupplier(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": SendLossObjectionForChangeOfSupplierInput
}

{
  "data": {
    "sendLossObjectionForChangeOfSupplier": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

sendOfferQuoteSummary

Type:SendOfferQuoteSummary

Send an offer quote summary to all active account users.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4178: No account found with given account number.
KT-CT-12407: The offer group does not contain an accepted offer.
KT-CT-5518: Account user not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OfferQuoteSummaryInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether the triggering of the offer quote summary was successful.

mutation SendOfferQuoteSummary($input: OfferQuoteSummaryInput!) {
  sendOfferQuoteSummary(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": OfferQuoteSummaryInput
}

{
  "data": {
    "sendOfferQuoteSummary": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

sendQuoteSummary

Type:SendQuoteSummary

Send a quote summary to the provided recipient.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4178: No account found with given account number.
KT-CT-4632: Invalid recipient information.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether the triggering of the quote summary was successful.

mutation SendQuoteSummary($input: QuoteShareInput!) {
  sendQuoteSummary(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": QuoteShareInput
}

{
  "data": {
    "sendQuoteSummary": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

sendVerificationEmail

Type:SendVerificationEmail

Verify user's email address.

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SendVerificationEmailInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

verificationStatus (Boolean)

If the verification email was sent.

mutation SendVerificationEmail($input: SendVerificationEmailInput!) {
  sendVerificationEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    verificationStatus
  }
}

{
  "input": SendVerificationEmailInput
}

{
  "data": {
    "sendVerificationEmail": {
      "possibleErrors": [PossibleErrorType],
      "verificationStatus": true
    }
  }
}

setClimateControlState

Type:SetClimateControlState

Turn a hot water device on or off.

The possible errors that can be raised are:

KT-CT-4337: Unable to set climate control state.
KT-CT-4301: Unable to find device for given account.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ClimateControlStateInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

mutation SetClimateControlState($input: ClimateControlStateInput) {
  setClimateControlState(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

{
  "input": ClimateControlStateInput
}

{
  "data": {
    "setClimateControlState": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setDevicePreferences

Set the user preferences for a device.

The possible errors that can be raised are:

KT-CT-4314: Unable to get provider details.
KT-CT-4321: Serializer validation error.
KT-CT-4374: An error occurred while trying to set your device preferences.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SmartFlexDevicePreferencesInput!)

The device preference details to be updated.

Return fields

Name	Description
`id` (`ID!`)	A UUID that identifies this device registration. Re-registering this device will result in a different ID.
`name` (`String`)	The user-friendly name for the device.
`deviceType` (`KrakenFlexDeviceTypes!`)	The type of device.
`provider` (`ProviderChoices!`)	The third-party that enables control of this device.
`integrationDeviceId` (`String`)	The third-party integration device ID.
`status` (`SmartFlexDeviceStatusInterface!`)	Information about the current status of this device.
`propertyId` (`String`)	The id of the property linked to the device.
`alerts` (`[SmartFlexDeviceAlertInterface]`)	Active alert message(s) for a device, showing the latest first.
`onboardingWizard` (`SmartFlexOnboardingWizard`)	The current onboarding wizard for a device.
`preferences` (`SmartFlexDevicePreferencesInterface`)	The device's preference details.
`preferenceSetting` (`FlexDevicePreferenceSettingInterface`)	The preference setting for this device.
`reAuthenticationState` (`DeviceReAuthenticationInterface`)	The re-authentication state of this device, if applicable.

mutation SetDevicePreferences($input: SmartFlexDevicePreferencesInput!) {
  setDevicePreferences(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

{
  "input": SmartFlexDevicePreferencesInput
}

{
  "data": {
    "setDevicePreferences": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

setHotWaterState

Type:SetHotWaterState

Turn a hot water device on or off.

The possible errors that can be raised are:

KT-CT-4336: Unable to set hot water state.
KT-CT-4301: Unable to find device for given account.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (HotWaterStateInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

mutation SetHotWaterState($input: HotWaterStateInput) {
  setHotWaterState(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

{
  "input": HotWaterStateInput
}

{
  "data": {
    "setHotWaterState": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setLoyaltyPointsUser

Type:SetLoyaltyPointsUser

Set the Loyalty Point user for the account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-9214: Couldn't assign user loyalty points role.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

newLoyaltyPointsUserId (String)

ID of the new Loyalty Points user.

mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
  setLoyaltyPointsUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    newLoyaltyPointsUserId
  }
}

{
  "input": SetLoyaltyPointsUserInput
}

{
  "data": {
    "setLoyaltyPointsUser": {
      "possibleErrors": [PossibleErrorType],
      "newLoyaltyPointsUserId": "abc123"
    }
  }
}

setOpportunityOutcome

Type:SetOpportunityOutcome

Update the opportunity outcome to mark the opportunity as won or lost.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetOpportunityOutcomeInput!)

Input fields for setting the outcome of a opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

message (String)

Success message for now.

mutation SetOpportunityOutcome($input: SetOpportunityOutcomeInput!) {
  setOpportunityOutcome(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

{
  "input": SetOpportunityOutcomeInput
}

{
  "data": {
    "setOpportunityOutcome": {
      "possibleErrors": [PossibleErrorType],
      "message": "abc123"
    }
  }
}

setPaymentPreference

Type:SetPaymentPreference

Set a preference to collect payments from a specific payment method.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3967: Payment method is not valid.
KT-CT-3968: Preference cannot be set this soon.
KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetPaymentPreferenceInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation SetPaymentPreference($input: SetPaymentPreferenceInput!) {
  setPaymentPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": SetPaymentPreferenceInput
}

{
  "data": {
    "setPaymentPreference": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

setReadingConsentGranularity

Type:SetReadingConsentGranularity

Mutation to set the reading consent granularity for a meter point.

Arguments

Name Description

input (SetReadingConsentGranularityInput!)

Input fields for setting the reading consent granularity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

readingConsentGranularitySubmitted (Boolean)

Whether the reading consent granularity was successfully submitted.

mutation SetReadingConsentGranularity($input: SetReadingConsentGranularityInput!) {
  setReadingConsentGranularity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    readingConsentGranularitySubmitted
  }
}

{
  "input": SetReadingConsentGranularityInput
}

{
  "data": {
    "setReadingConsentGranularity": {
      "possibleErrors": [PossibleErrorType],
      "readingConsentGranularitySubmitted": true
    }
  }
}

setRoomTemperature

Type:SetRoomTemperature

Turn a hot water device on or off.

The possible errors that can be raised are:

KT-CT-4329: Invalid data.
KT-CT-4346: Unable to set the room temperature.
KT-CT-7223: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RoomTemperatureInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

mutation SetRoomTemperature($input: RoomTemperatureInput) {
  setRoomTemperature(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

{
  "input": RoomTemperatureInput
}

{
  "data": {
    "setRoomTemperature": {
      "possibleErrors": [PossibleErrorType],
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setUpDirectDebitInstruction

Type:SetUpDirectDebitInstruction

Set up a new direct debit instruction.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3940: Invalid data.
KT-CT-5415: Account user not found.
KT-CT-11103: Business not found.
KT-CT-3971: Instruction owners are not valid.
KT-CT-3979: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (DirectDebitInstructionType)

mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
  setUpDirectDebitInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": SetUpDirectDebitInstructionInput
}

{
  "data": {
    "setUpDirectDebitInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setUpDirectDebitInstructionForBusiness

Type:SetUpDirectDebitInstructionForBusiness

Set up a new direct debit instruction for a business.

The possible errors that can be raised are:

KT-CT-3940: Invalid data.
KT-CT-3956: Temporary error occurred.
KT-CT-11107: Unauthorized.
KT-CT-3948: Could not set up direct debit instruction.
KT-CT-3971: Instruction owners are not valid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetUpDirectDebitInstructionForBusinessInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (DirectDebitInstructionType)

The created direct debit instruction.

mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
  setUpDirectDebitInstructionForBusiness(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": SetUpDirectDebitInstructionForBusinessInput
}

{
  "data": {
    "setUpDirectDebitInstructionForBusiness": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setUpDirectDebitInstructionFromStoredDetails

Type:SetUpDirectDebitInstructionFromStoredDetails

Set up a new direct debit instruction from stored details.

The possible errors that can be raised are:

KT-CT-3956: Temporary error occurred.
KT-CT-3948: Could not set up direct debit instruction.
KT-CT-3971: Instruction owners are not valid.
KT-CT-5415: Account user not found.
KT-CT-11103: Business not found.
KT-CT-4123: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetUpDirectDebitInstructionFromStoredDetailsInput!)

Input fields for creating a new direct debit instruction from stored details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (DirectDebitInstructionType)

The payment instruction that was created from stored details.

mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
  setUpDirectDebitInstructionFromStoredDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": SetUpDirectDebitInstructionFromStoredDetailsInput
}

{
  "data": {
    "setUpDirectDebitInstructionFromStoredDetails": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setVehicleChargePreferences

Type:SetVehicleChargingPreferences

Set charging preferences for your electric vehicle.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4321: Serializer validation error.
KT-CT-4353: An error occurred while trying to update your charging preferences.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'setVehicleChargePreferences' field is deprecated.

Please use `setDevicePreferences` instead of this endpoint.

- Marked as deprecated on 2024-09-18.
- Scheduled for removal on or after 2026-01-26.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/469/

Arguments

Name Description

input (VehicleChargingPreferencesInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation SetVehicleChargePreferences($input: VehicleChargingPreferencesInput) {
  setVehicleChargePreferences(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": VehicleChargingPreferencesInput
}

{
  "data": {
    "setVehicleChargePreferences": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

setZoneMode

Type:SetZoneMode

Turn a specific heating controller zone ON/OFF, set it to AUTO mode or give it a BOOST.

The possible errors that can be raised are:

KT-CT-4333: Invalid data.
KT-CT-4306: Error setting mode for heat pump controller zone.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

operationParameters (SetZoneModeParameters!)

The parameters required to instruct a specific zone operation.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with a zone's mode operation.

mutation SetZoneMode(
  $accountNumber: String!,
  $euid: ID!,
  $operationParameters: SetZoneModeParameters!
) {
  setZoneMode(
    accountNumber: $accountNumber,
    euid: $euid,
    operationParameters: $operationParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "operationParameters": SetZoneModeParameters
}

{
  "data": {
    "setZoneMode": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

setZoneSchedules

Type:SetZoneSchedules

Add schedules for a heating controller zone.

The possible errors that can be raised are:

KT-CT-4334: Invalid data.
KT-CT-4308: Error setting schedule(s) for heat pump controller zone.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

zoneScheduleParameters (SetZoneSchedulesParameters!)

The parameters required to add schedule(s) for a specific zone.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with adding schedule(s) for a zone.

mutation SetZoneSchedules(
  $accountNumber: String!,
  $euid: ID!,
  $zoneScheduleParameters: SetZoneSchedulesParameters!
) {
  setZoneSchedules(
    accountNumber: $accountNumber,
    euid: $euid,
    zoneScheduleParameters: $zoneScheduleParameters
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "zoneScheduleParameters": SetZoneSchedulesParameters
}

{
  "data": {
    "setZoneSchedules": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

shareGoodsQuote

Type:ShareGoodsQuote

Share a goods quote.

The possible errors that can be raised are:

KT-CT-4122: Invalid email.
KT-CT-8203: Received an invalid quote code.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ShareGoodsQuoteInput!)

Input fields for sharing a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

share (GoodsQuoteShare)

Goods quote shared.

mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
  shareGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    share {
      ...GoodsQuoteShareFragment
    }
  }
}

{
  "input": ShareGoodsQuoteInput
}

{
  "data": {
    "shareGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "share": GoodsQuoteShare
    }
  }
}

skipSsdPayment

Type:SkipSSDPayment

Skip the SSD payment for an account which is yet to enrol to Octopus as a supplier.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-GB-4137: Could not cancel SSD payment.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SkipSsdPaymentInput!)

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`skippedPaymentAmount` (`Int!`)	The amount of the skipped payment.
`skippedPaymentDate` (`Date`)	The date of the payment that was skipped.
`nextPaymentAmount` (`Int`)	The amount of the next scheduled payment for the account.
`nextPaymentDate` (`Date`)	The date of the next scheduled payment for the account.

mutation SkipSsdPayment($input: SkipSsdPaymentInput!) {
  skipSsdPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    skippedPaymentAmount
    skippedPaymentDate
    nextPaymentAmount
    nextPaymentDate
  }
}

{
  "input": SkipSsdPaymentInput
}

{
  "data": {
    "skipSsdPayment": {
      "possibleErrors": [PossibleErrorType],
      "skippedPaymentAmount": 1,
      "skippedPaymentDate": "2020-01-01",
      "nextPaymentAmount": 1,
      "nextPaymentDate": "2020-01-01"
    }
  }
}

smets2Interest

Type:UpdateAccountSmartMeterInterest

Set stated interest in procuring a smart meter for an account.

The possible errors that can be raised are:

KT-GB-4115: Could not create smart meter interest for account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountSmartMeterInterestInput)

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`interestUpdated` (`Boolean`)
`smets2Interest` (`SmartMeterInterestChoices`)	The interest of an account in procuring smart meters.
`smets2InterestSource` (`SmartMeterInterestSourceChoices`)	The source category of the smart meter interest update.
`smets2RefusalReason` (`SMETS2InterestReason`)	The reason why the account holder is not interested in having a smart meter installed.

mutation Smets2Interest($input: UpdateAccountSmartMeterInterestInput) {
  smets2Interest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    interestUpdated
    smets2Interest
    smets2InterestSource
    smets2RefusalReason
  }
}

{
  "input": UpdateAccountSmartMeterInterestInput
}

{
  "data": {
    "smets2Interest": {
      "possibleErrors": [PossibleErrorType],
      "interestUpdated": true,
      "smets2Interest": "PRIORITY",
      "smets2InterestSource": "WEBSITE",
      "smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME"
    }
  }
}

spinWheelOfFortune

Type:SpinWheelOfFortune

Submit a spin of the Wheel of Fortune for the given account and supply type.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-7011: Terms must be accepted.
KT-CT-7023: Unauthorized.
KT-CT-7010: The account does not have any available submissions.
KT-CT-7012: Wheel of Fortune submission error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'spinWheelOfFortune' field is deprecated.

We're migrating the system the Wheel of Fortune runs on. Octopus Energy UK customers can find the new API under api.backend.octopus.energy/v1/graphql/

- Marked as deprecated on 2025-06-24.
- Scheduled for removal on or after 2025-09-24.

Arguments

Name Description

input (WheelOfFortuneSpinInput!)

Input fields for creating a Wheel of Fortune submission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

spinResult (WheelOfFortuneSpinResultType)

The result of the Wheel of Fortune spin.

This field requires the Authorization header to be set.

mutation SpinWheelOfFortune($input: WheelOfFortuneSpinInput!) {
  spinWheelOfFortune(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    spinResult {
      ...WheelOfFortuneSpinResultTypeFragment
    }
  }
}

{
  "input": WheelOfFortuneSpinInput
}

{
  "data": {
    "spinWheelOfFortune": {
      "possibleErrors": [PossibleErrorType],
      "spinResult": WheelOfFortuneSpinResultType
    }
  }
}

startCollectionProcess

Type:StartCollectionProcess

Start a collection process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11208: Invalid billing document identifier for collection process.
KT-CT-11209: Collection process configuration does not have published version.
KT-CT-11210: Active collection process for entity already exists.
KT-CT-11211: Too many active collection processes for config.
KT-CT-11212: Invalid collection process config code.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartCollectionProcessInput!)

Details to start collection process for.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessStarted (StartCollectionProcessOutput)

Details of collection process that has been started.

mutation StartCollectionProcess($input: StartCollectionProcessInput!) {
  startCollectionProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessStarted {
      ...StartCollectionProcessOutputFragment
    }
  }
}

{
  "input": StartCollectionProcessInput
}

{
  "data": {
    "startCollectionProcess": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessStarted": StartCollectionProcessOutput
    }
  }
}

startCustomerVerification

Type:StartCustomerVerification

Start the customer verification using the provided verification method.

The possible errors that can be raised are:

KT-CT-1701: Brand does not exist.
KT-CT-4194: Verification type not supported yet.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartCustomerVerificationInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

verificationProcess (VerificationProcess)

The newly created verification process.

mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
  startCustomerVerification(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    verificationProcess {
      ...VerificationProcessFragment
    }
  }
}

{
  "input": StartCustomerVerificationInput
}

{
  "data": {
    "startCustomerVerification": {
      "possibleErrors": [PossibleErrorType],
      "verificationProcess": VerificationProcess
    }
  }
}

startExportOnboardingProcess

Type:StartExportOnboardingProcess

Start export onboarding process for an account.

The possible errors that can be raised are:

KT-GB-4103: Unable to start export onboarding process.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (StartExportOnboardingProcessInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onboardingProcess (SmartOnboardingProcessType)

productEnrolment (ProductEnrolmentType)

The product enrolment process created.

mutation StartExportOnboardingProcess($input: StartExportOnboardingProcessInput) {
  startExportOnboardingProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onboardingProcess {
      ...SmartOnboardingProcessTypeFragment
    }
    productEnrolment {
      ...ProductEnrolmentTypeFragment
    }
  }
}

{
  "input": StartExportOnboardingProcessInput
}

{
  "data": {
    "startExportOnboardingProcess": {
      "possibleErrors": [PossibleErrorType],
      "onboardingProcess": SmartOnboardingProcessType,
      "productEnrolment": ProductEnrolmentType
    }
  }
}

startOnSiteJobsAppointmentBookingSession

Type:StartOnSiteJobsAppointmentBookingSession

Start the appointment booking process for an on-site jobs request.

The possible errors that can be raised are:

KT-CT-13010: No booking adapter found for agent.
KT-CT-13020: Could not identify agent from property.
KT-CT-13021: Invalid job type.
KT-CT-13022: Work category not found for job type.
KT-CT-13023: Appointment booking checks failed.
KT-CT-13024: Appointment booking checks returned warnings.
KT-CT-13032: Request does not exist.
KT-CT-13054: Appointment not found for rescheduling.
KT-CT-13055: Appointment does not belong to the specified request.
KT-CT-13056: Appointment cannot be rescheduled.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name	Description
`appointmentBookingDetails` (`OnSiteJobsAppointmentBookingDetailsInput!`)	The appointment booking details.
`appointmentIdToReschedule` (`UUID`)	The ID of an existing appointment to reschedule. If provided, this booking session will be used to reschedule the appointment instead of creating a new one.
`overrideAppointmentCheckWarnings` (`Boolean`)	Whether to override appointment booking check warnings. Defaults to False.
`requestId` (`UUID!`)	The ID of the request to book an appointment for.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

appointmentBookingSessionId (UUID)

The Kraken booking ID for the appointment booking session.

mutation StartOnSiteJobsAppointmentBookingSession(
  $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
  $appointmentIdToReschedule: UUID,
  $overrideAppointmentCheckWarnings: Boolean,
  $requestId: UUID!
) {
  startOnSiteJobsAppointmentBookingSession(
    appointmentBookingDetails: $appointmentBookingDetails,
    appointmentIdToReschedule: $appointmentIdToReschedule,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
    requestId: $requestId
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    appointmentBookingSessionId
  }
}

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "appointmentIdToReschedule": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "overrideAppointmentCheckWarnings": true,
  "requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

{
  "data": {
    "startOnSiteJobsAppointmentBookingSession": {
      "possibleErrors": [PossibleErrorType],
      "appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
    }
  }
}

startOnboardingProcess

Type:StartSmartOnboardingProcess

Start smart onboarding process for an account.

The possible errors that can be raised are:

KT-GB-4102: Unable to start smart onboarding process.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartSmartOnboardingProcessInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onboardingProcess (SmartOnboardingProcessType)

productEnrolment (ProductEnrolmentType)

The product enrolment process created.

mutation StartOnboardingProcess($input: StartSmartOnboardingProcessInput) {
  startOnboardingProcess(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onboardingProcess {
      ...SmartOnboardingProcessTypeFragment
    }
    productEnrolment {
      ...ProductEnrolmentTypeFragment
    }
  }
}

{
  "input": StartSmartOnboardingProcessInput
}

{
  "data": {
    "startOnboardingProcess": {
      "possibleErrors": [PossibleErrorType],
      "onboardingProcess": SmartOnboardingProcessType,
      "productEnrolment": ProductEnrolmentType
    }
  }
}

startReAuthentication

Type:StartReAuthentication

Create a wizard for re-authenticating a device with SmartFlex.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-4385: Re-authentication is not supported for this device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartReAuthenticationInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for re-authenticating the device with SmartFlex.

mutation StartReAuthentication($input: StartReAuthenticationInput!) {
  startReAuthentication(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": StartReAuthenticationInput
}

{
  "data": {
    "startReAuthentication": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

startSmartFlexOnboarding

Type:StartSmartFlexOnboarding

Create a wizard for onboarding a device with SmartFlex.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-4385: Re-authentication is not supported for this device.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StartSmartFlexOnboardingInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation StartSmartFlexOnboarding($input: StartSmartFlexOnboardingInput!) {
  startSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": StartSmartFlexOnboardingInput
}

{
  "data": {
    "startSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

startTestChargeForSmartFlexOnboarding

Type:StartTestChargeForSmartFlexOnboarding

Attempt to start a test charge.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4371: Onboarding wizard ID is invalid.
KT-CT-4372: Simultaneous attempts to update onboarding process.
KT-CT-4375: Incorrect or missing parameters for SmartFlex onboarding step.
KT-CT-4376: Unable to complete onboarding step. Please try again later.
KT-CT-4377: Invalid onboarding step ID.
KT-CT-4378: Invalid input or step id. Please make sure you are using the correct step id and providing the expected input params.
KT-CT-4379: Vehicle is not ready for a test charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'startTestChargeForSmartFlexOnboarding' field is deprecated.

This functionality will no longer be available.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

mutation StartTestChargeForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  startTestChargeForSmartFlexOnboarding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

{
  "input": CompleteSmartFlexOnboardingStepInput
}

{
  "data": {
    "startTestChargeForSmartFlexOnboarding": {
      "possibleErrors": [PossibleErrorType],
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

stopAutomatedPayments

Type:StopAutomatedPayments

Set a preference to not collect automated payments.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3968: Preference cannot be set this soon.
KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StopAutomatedPaymentsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

mutation StopAutomatedPayments($input: StopAutomatedPaymentsInput!) {
  stopAutomatedPayments(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

{
  "input": StopAutomatedPaymentsInput
}

{
  "data": {
    "stopAutomatedPayments": {
      "possibleErrors": [PossibleErrorType]
    }
  }
}

storeDirectDebitPaymentMethodDetails

Type:StoreDirectDebitPaymentMethodDetails

Store bank details with the vendor.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3940: Invalid data.
KT-CT-3956: Temporary error occurred.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StoreDirectDebitPaymentMethodDetailsInput!)

Store bank details with the vendor.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

storedPaymentMethodDetailsReference (String)

mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
  storeDirectDebitPaymentMethodDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    storedPaymentMethodDetailsReference
  }
}

{
  "input": StoreDirectDebitPaymentMethodDetailsInput
}

{
  "data": {
    "storeDirectDebitPaymentMethodDetails": {
      "possibleErrors": [PossibleErrorType],
      "storedPaymentMethodDetailsReference": "abc123"
    }
  }
}

storeElectricJuicePaymentInstruction

Type:StoreElectricJuicePaymentInstruction

Store a new card instruction for Electric Juice from an embedded form.

The possible errors that can be raised are:

KT-CT-3923: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'storeElectricJuicePaymentInstruction' field is deprecated.

Legacy Market

- Marked as deprecated on 2025-08-04.
- Scheduled for removal on or after 2025-09-05.

Arguments

Name Description

input (StoreElectricJuicePaymentInstructionInput!)

Input fields for storing a new card instruction from an embedded form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (PaymentInstructionType)

mutation StoreElectricJuicePaymentInstruction($input: StoreElectricJuicePaymentInstructionInput!) {
  storeElectricJuicePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
  }
}

{
  "input": StoreElectricJuicePaymentInstructionInput
}

{
  "data": {
    "storeElectricJuicePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": PaymentInstructionType
    }
  }
}

storePaymentInstruction

Type:StorePaymentInstruction

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3979: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StorePaymentInstructionInput!)

Input fields for storing a new payment instruction created through the embedded process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (PaymentInstructionType)

The stored payment instruction.

mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
  storePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
  }
}

{
  "input": StorePaymentInstructionInput
}

{
  "data": {
    "storePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": PaymentInstructionType
    }
  }
}

submitCustomerFeedback

Type:SubmitCustomerFeedback

Submit customer feedback.

The possible errors that can be raised are:

KT-CT-5514: Unable to submit feedback.
KT-CT-5511: The feedback_id should be provided for feedback source.
KT-CT-5512: The feedback doesn't match the account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CustomerFeedbackInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

customerFeedback (CustomerFeedbackType)

mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
  submitCustomerFeedback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

{
  "input": CustomerFeedbackInputType
}

{
  "data": {
    "submitCustomerFeedback": {
      "possibleErrors": [PossibleErrorType],
      "customerFeedback": CustomerFeedbackType
    }
  }
}

submitRepaymentRequest

Type:SubmitRepaymentRequest

Submit a repayment request.

The possible errors that can be raised are:

KT-CT-1132: Unauthorized.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3823: Unauthorized.
KT-CT-3926: Unauthorized.
KT-CT-3927: Invalid Amount.
KT-CT-3928: Idempotency key used for another repayment request.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestRepaymentInputType!)

Input fields for requesting a repayment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentRequest (RequestRepaymentOutputType)

The newly created repayment request.

mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
  submitRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...RequestRepaymentOutputTypeFragment
    }
  }
}

{
  "input": RequestRepaymentInputType
}

{
  "data": {
    "submitRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": RequestRepaymentOutputType
    }
  }
}

suspendControl

Type:SuspendDeviceControl

Suspend control of the device.

The possible errors that can be raised are:

KT-CT-4301: Unable to find device for given account.
KT-CT-4358: Unable to suspend device control.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'suspendControl' field is deprecated.

Please use 'updateDeviceSmartControl' instead.

- Marked as deprecated on 2024-09-17.
- Scheduled for removal on or after 2025-12-11.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/468/

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation SuspendControl($input: AccountNumberInput) {
  suspendControl(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "suspendControl": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

switchAccountToVariablePaymentSchedule

Type:SwitchAccountToVariablePaymentSchedule

Switch account to variable payment schedule. Current schedule type will be preserved.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3921: Account not found.
KT-CT-3922: Ledger not found for the account.
KT-CT-3947: An unexpected error occurred.
KT-CT-3984: Could not delete conflicting future payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SwitchAccountToVariablePaymentScheduleInput!)

Input fields for switching to a variable payment schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

schedule (PaymentScheduleType!)

New payment schedule.

mutation SwitchAccountToVariablePaymentSchedule($input: SwitchAccountToVariablePaymentScheduleInput!) {
  switchAccountToVariablePaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": SwitchAccountToVariablePaymentScheduleInput
}

{
  "data": {
    "switchAccountToVariablePaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

switchMeterPointProducts

Type:SwitchMeterPointProducts

Switch the specified meter points to the chosen product.

The possible errors that can be raised are:

KT-GB-4116: Invalid data.
KT-GB-4617: Quoted product not found.
KT-CT-4623: Unauthorized.
KT-GB-4117: Unable to process product switch.
KT-GB-4119: Meter point already on another account.
KT-GB-4120: MPxN has no active agreement.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SwitchMeterPointProductsInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The account associated with the meter points whose products were switched.

mutation SwitchMeterPointProducts($input: SwitchMeterPointProductsInput) {
  switchMeterPointProducts(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": SwitchMeterPointProductsInput
}

{
  "data": {
    "switchMeterPointProducts": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

synchroniseClock

Type:SynchroniseClock

Triggers an asynchronous request to synchronise the clock on a meter device.

The possible errors that can be raised are:

KT-GB-4024: The provided device ID does not match any devices known by Kraken.
KT-GB-4019: This device type is not currently supported.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SynchroniseClockInput!)

Input field for a synchronise clock request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The reference for the associated request in Kraken.

mutation SynchroniseClock($input: SynchroniseClockInput!) {
  synchroniseClock(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": SynchroniseClockInput
}

{
  "data": {
    "synchroniseClock": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

terminateAgreement

Type:TerminateAgreement

Terminate an agreement.

The possible errors that can be raised are:

KT-CT-1501: Agreement not found.
KT-CT-1513: Unable to terminate agreement.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TerminateAgreementInput!)

Input for terminating an agreement.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreement (CommonAgreementType)

The created agreement.

mutation TerminateAgreement($input: TerminateAgreementInput!) {
  terminateAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

{
  "input": TerminateAgreementInput
}

{
  "data": {
    "terminateAgreement": {
      "possibleErrors": [PossibleErrorType],
      "agreement": CommonAgreementType
    }
  }
}

terminateContract

Type:TerminateContractOutput!

Terminate an existing contract.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10007: Unable to terminate contract.
KT-CT-10008: The contract is currently undergoing an active journey.
KT-CT-10013: Requested termination date is invalid.
KT-CT-10022: Contract already terminated.
KT-CT-10023: Contract is already revoked.
KT-CT-10024: Contract already expired.
KT-CT-10025: Contract has not started yet.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TerminateContractInput!)

Return fields

Name	Description

mutation TerminateContract($input: TerminateContractInput!) {
  terminateContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

{
  "input": TerminateContractInput
}

{
  "data": {
    "terminateContract": {
      "contract": Contract
    }
  }
}

terminateCreditTransferPermission

Type:TerminateCreditTransferPermission

Terminate credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3825: Credit transfer permission not found.
KT-CT-3827: The ledger is not valid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TerminateCreditTransferPermissionInput!)

Input fields for terminating a credit transfer permission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

validTo (DateTime)

Datetime when the credit transfer permission ends.

mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
  terminateCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validTo
  }
}

{
  "input": TerminateCreditTransferPermissionInput
}

{
  "data": {
    "terminateCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validTo": "2020-01-01T00:00:00.000Z"
    }
  }
}

thirdPartyCompleteDeviceRegistration

Type:ThirdPartyCompleteDeviceRegistration

Completes the registration of a device if the contract is eligible and the device registration valid.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-4322: Unable to complete registration error.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'thirdPartyCompleteDeviceRegistration' field is deprecated.

This functionality will no longer be available.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

Name Description

input (CompleteDeviceRegistrationInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (ThirdPartyCompleteDeviceRegistrationType)

The response showing account validity and optional tariff information.

mutation ThirdPartyCompleteDeviceRegistration($input: CompleteDeviceRegistrationInput) {
  thirdPartyCompleteDeviceRegistration(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success {
      ...ThirdPartyCompleteDeviceRegistrationTypeFragment
    }
  }
}

{
  "input": CompleteDeviceRegistrationInput
}

{
  "data": {
    "thirdPartyCompleteDeviceRegistration": {
      "possibleErrors": [PossibleErrorType],
      "success": ThirdPartyCompleteDeviceRegistrationType
    }
  }
}

transferLeadOpportunities

Type:TransferLeadOpportunities

Transfer opportunities across leads.

The possible errors that can be raised are:

KT-CT-8907: Lead not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TransferLeadOpportunitiesInput!)

Input for transfer opportunities across leads.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

opportunitiesTransferred (Int)

Number of opportunities transferred.

mutation TransferLeadOpportunities($input: TransferLeadOpportunitiesInput!) {
  transferLeadOpportunities(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunitiesTransferred
  }
}

{
  "input": TransferLeadOpportunitiesInput
}

{
  "data": {
    "transferLeadOpportunities": {
      "possibleErrors": [PossibleErrorType],
      "opportunitiesTransferred": 1
    }
  }
}

transferLedgerBalance

Type:TransferLedgerBalance

Transfer value from a source ledger to a destination ledger. This decreases the balance of the source ledger by the given amount and increases the balance of the destination ledger by the same amount. If the amount is negative, the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases).

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3823: Unauthorized.
KT-CT-9701: Balance transfer to same account is not allowed.
KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
KT-CT-9703: Balance transfer is not supported for debit account.
KT-CT-9704: Balance transfer amount should be non-zero.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TransferLedgerBalanceInputType!)

Input fields for processing an account balance transfer.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

balanceTransfer (AccountBalanceTransferType)

Balance transfer details.

mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
  transferLedgerBalance(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    balanceTransfer {
      ...AccountBalanceTransferTypeFragment
    }
  }
}

{
  "input": TransferLedgerBalanceInputType
}

{
  "data": {
    "transferLedgerBalance": {
      "possibleErrors": [PossibleErrorType],
      "balanceTransfer": AccountBalanceTransferType
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type:TransferLoyaltyPointsBetweenUsers

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsTransferred (Int)

The number of loyalty points that were transferred.

mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
  transferLoyaltyPointsBetweenUsers(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsTransferred
  }
}

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

{
  "data": {
    "transferLoyaltyPointsBetweenUsers": {
      "possibleErrors": [PossibleErrorType],
      "pointsTransferred": 1
    }
  }
}

triggerBoostCharge

Type:PerformBoostCharge

Initiate a boost charge for an electric vehicle (EV).

This will start charging the EV and will not stop until the battery reaches 100% charged.

If it is not possible to initiate a boost charge, a KT-CT-4357 error will be returned. It may have a boostChargeRefusalReasons extension which lists the reasons why the boost charge was refused. Possible reasons include:

BC_DEVICE_NOT_YET_LIVE (device is not yet live)
BC_DEVICE_RETIRED (device is retired)
BC_DEVICE_SUSPENDED (device is suspended)
BC_DEVICE_DISCONNECTED (device is disconnected)
BC_DEVICE_NOT_AT_HOME (device is not at home)
BC_BOOST_CHARGE_IN_PROGRESS (boost charge already in progress)
BC_DEVICE_FULLY_CHARGED (device is already fully charged)

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4356: A boost charge cannot currently be performed.
KT-CT-4357: Unable to trigger boost charge.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'triggerBoostCharge' field is deprecated.

Please use 'updateBoostCharge' instead.

- Marked as deprecated on 2025-05-12.
- Scheduled for removal on or after 2026-01-26.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/607/

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation TriggerBoostCharge($input: AccountNumberInput) {
  triggerBoostCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "triggerBoostCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

triggerCollectionProcessMessage

Type:TriggerCollectionProcessMessage

Trigger a collection process message with safety checks.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TriggerCollectionProcessMessageInput!)

Input for sending a collection process communication.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

triggerResult (TriggerCollectionProcessMessageOutput)

Details of the triggered communication.

mutation TriggerCollectionProcessMessage($input: TriggerCollectionProcessMessageInput!) {
  triggerCollectionProcessMessage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    triggerResult {
      ...TriggerCollectionProcessMessageOutputFragment
    }
  }
}

{
  "input": TriggerCollectionProcessMessageInput
}

{
  "data": {
    "triggerCollectionProcessMessage": {
      "possibleErrors": [PossibleErrorType],
      "triggerResult": TriggerCollectionProcessMessageOutput
    }
  }
}

triggerPostUploadOperations

Type:TriggerPostUploadOperations!

The possible errors that can be raised are:

KT-CT-8710: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

s3Key (String!)

Return fields

Name	Description

mutation TriggerPostUploadOperations($s3Key: String!) {
  triggerPostUploadOperations(s3Key: $s3Key) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    operationsTriggered
  }
}

{
  "s3Key": "abc123"
}

{
  "data": {
    "triggerPostUploadOperations": {
      "possibleErrors": [PossibleErrorType],
      "operationsTriggered": true
    }
  }
}

triggerTestCharge

Type:PerformTestCharge

Initiate a test charge of an electric vehicle (EV).

This is to ensure that the EV or EVSE (charge point) can be controlled remotely and successfully charged for a short period.

If it is not possible to initiate a test charge, a KT-CT-4355 error will be returned. It may have a testChargeRefusalReasons extension which lists the reasons why the test charge was refused. Possible reasons include:

TC_DEVICE_LIVE (device is already live)
TC_DEVICE_ONBOARDING_IN_PROGRESS (test dispatch already in progress)
TC_DEVICE_RETIRED (device is retired)
TC_DEVICE_SUSPENDED (device is suspended)
TC_DEVICE_DISCONNECTED (device is disconnected)
TC_DEVICE_ALREADY_CHARGING (device is already charging)
TC_DEVICE_AWAY_FROM_HOME (device is away from home)
TC_DEVICE_NO_LOCATION_CONFIGURED (device has no location configured)
TC_DEVICE_LOCATION_UNABLE_TO_IDENTIFY (unable to identify device location)
TC_DEVICE_LOCATION_MISSING (device location is missing)

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4362: Device not ready for test charge.
KT-CT-4355: Unable to trigger charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

krakenflexDevice (KrakenFlexDeviceType)

mutation TriggerTestCharge($input: AccountNumberInput) {
  triggerTestCharge(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

{
  "input": AccountNumberInput
}

{
  "data": {
    "triggerTestCharge": {
      "possibleErrors": [PossibleErrorType],
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

unenrollAccountFromLoyaltyProgram

Type:UnenrollAccountFromLoyaltyProgram

Unenroll users account from Loyalty program.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9220: Ineligible loyalty points unenrollment.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UnenrollAccountFromLoyaltyProgramInput!)

The account number to unenroll from the loyalty program.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

outcome (UnenrollAccountFromLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

mutation UnenrollAccountFromLoyaltyProgram($input: UnenrollAccountFromLoyaltyProgramInput!) {
  unenrollAccountFromLoyaltyProgram(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    outcome {
      ...UnenrollAccountFromLoyaltyProgramOutcomeFragment
    }
  }
}

{
  "input": UnenrollAccountFromLoyaltyProgramInput
}

{
  "data": {
    "unenrollAccountFromLoyaltyProgram": {
      "possibleErrors": [PossibleErrorType],
      "outcome": UnenrollAccountFromLoyaltyProgramOutcome
    }
  }
}

unlinkUserFromLine

Type:UnlinkUserFromLineResponse!

Unlink an account user and line together.

Return fields

Name	Description

mutation UnlinkUserFromLine {
  unlinkUserFromLine {
    ... on LineUnlinkedResponse {
      ...LineUnlinkedResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on LineCommonError {
      ...LineCommonErrorFragment
    }
  }
}

{
  "data": {
    "unlinkUserFromLine": LineUnlinkedResponse
  }
}

updateAccountBillingAddress

Type:UpdateAccountBillingAddress

Update the account billing address.

The possible errors that can be raised are:

KT-CT-4145: Invalid address.
KT-CT-7123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The updated account.

mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
  updateAccountBillingAddress(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": AccountBillingAddressInput
}

{
  "data": {
    "updateAccountBillingAddress": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

updateAccountBillingEmail

Type:UpdateAccountBillingEmail

Update account billing email.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4122: Invalid email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountInterface)

Account that was changed.

mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
  updateAccountBillingEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateAccountBillingEmailInput
}

{
  "data": {
    "updateAccountBillingEmail": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateAccountConsents

Type:UpdateAccountConsents

Update the consents of an account

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-9018: Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consents ([ConsentType!]!)

Consents linked to this account.

mutation UpdateAccountConsents(
  $accountNumber: String!,
  $consents: [ConsentInput]!
) {
  updateAccountConsents(
    accountNumber: $accountNumber,
    consents: $consents
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consents {
      ...ConsentTypeFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "consents": ConsentInput
}

{
  "data": {
    "updateAccountConsents": {
      "possibleErrors": [PossibleErrorType],
      "consents": ConsentType
    }
  }
}

updateAccountReference

Type:UpdateAccountReference

Update an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReference (AccountReferenceType)

mutation UpdateAccountReference($input: AccountReferenceInput!) {
  updateAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "updateAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

updateAccountReferralStatus

Type:UpdateAccountReferralStatus

Update the status of an account referral.

The possible errors that can be raised are:

KT-CT-6712: Invalid reference.
KT-CT-6732: Invalid referral status transition.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountReferralStatusInput!)

Input fields for updating the status of an account referral.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReferral (ReferralType)

The updated account referral instance.

mutation UpdateAccountReferralStatus($input: UpdateAccountReferralStatusInput!) {
  updateAccountReferralStatus(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

{
  "input": UpdateAccountReferralStatusInput
}

{
  "data": {
    "updateAccountReferralStatus": {
      "possibleErrors": [PossibleErrorType],
      "accountReferral": ReferralType
    }
  }
}

updateAccountUserConsents

Type:UpdateAccountUserConsents

Update the consents of an account user (the authenticated user)

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-1111: Unauthorized.
KT-CT-5421: Account user not found.
KT-CT-5422: Invalid data.
KT-CT-1605: Invalid input.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

consents ([ConsentTypeInput])

Consents to update for account user.

userNumber (String)

User number of the account user to update consents for. Only needed if the viewer is an organization.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountUserConsents (AccountUserConsents)

All the consents for an account user.

mutation UpdateAccountUserConsents(
  $consents: [ConsentTypeInput],
  $userNumber: String
) {
  updateAccountUserConsents(
    consents: $consents,
    userNumber: $userNumber
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

{
  "consents": ConsentTypeInput,
  "userNumber": "abc123"
}

{
  "data": {
    "updateAccountUserConsents": {
      "possibleErrors": [PossibleErrorType],
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateActivePurchase

Type:UpdateActivePurchase

Update an active purchase.

The possible errors that can be raised are:

KT-CT-8225: Received an invalid purchaseId.
KT-CT-8226: The provided purchase is not active.
KT-CT-8206: Invalid data.
KT-CT-8227: Available grants could not be applied.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsPurchase (GoodsPurchase)

Goods purchase updated.

mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
  updateActivePurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": UpdatePurchaseInput
}

{
  "data": {
    "updateActivePurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

updateAffiliateLink

Type:UpdateAffiliateLink!

Update an existing affiliate link.

The possible errors that can be raised are:

KT-CT-7711: Invalid data.
KT-CT-7713: Invalid data.
KT-CT-7714: Invalid data.
KT-CT-7715: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAffiliateLinkInputType!)

Input fields for Updating an existing affiliate link.

Return fields

Name	Description

mutation UpdateAffiliateLink($input: UpdateAffiliateLinkInputType!) {
  updateAffiliateLink(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

{
  "input": UpdateAffiliateLinkInputType
}

{
  "data": {
    "updateAffiliateLink": {
      "possibleErrors": [PossibleErrorType],
      "affiliateLink": AffiliateLinkType
    }
  }
}

updateAffiliateOrganisation

Type:UpdateAffiliateOrganisation!

Update an existing affiliate organisation.

The possible errors that can be raised are:

KT-CT-7717: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAffiliateOrganisationInputType!)

Input fields for Updating an existing affiliate organisation.

Return fields

Name	Description

mutation UpdateAffiliateOrganisation($input: UpdateAffiliateOrganisationInputType!) {
  updateAffiliateOrganisation(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

{
  "input": UpdateAffiliateOrganisationInputType
}

{
  "data": {
    "updateAffiliateOrganisation": {
      "possibleErrors": [PossibleErrorType],
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

updateAgentAuxiliaryStatus

Type:UpdateAgentAuxiliaryStatus

The possible errors that can be raised are:

KT-CT-7813: Support user not found with that username.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAgentAuxiliaryStatusInput!)

The input data for this mutation.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Whether the auxiliary status was successfully updated.

mutation UpdateAgentAuxiliaryStatus($input: UpdateAgentAuxiliaryStatusInput!) {
  updateAgentAuxiliaryStatus(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": UpdateAgentAuxiliaryStatusInput
}

{
  "data": {
    "updateAgentAuxiliaryStatus": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

updateAgreementPeriod

Type:UpdateAgreementPeriod

Update the period of an agreement.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-1501: Agreement not found.
KT-CT-1503: Agreement validto date must be later than validfrom date.
KT-CT-1504: Account does not match with the agreement.
KT-CT-1505: Unable to edit agreement.
KT-CT-1506: Agreement period is not within the supply and property period.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAgreementPeriodInput!)

Input for updating the agreement period.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

Account responsible for the update agreement.

mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
  updateAgreementPeriod(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": UpdateAgreementPeriodInput
}

{
  "data": {
    "updateAgreementPeriod": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

updateAgreementRescission

Type:UpdateAgreementRescission

Update an agreement rescission.

The possible errors that can be raised are:

KT-CT-14101: Agreement rescission not found.
KT-CT-14102: Cannot update completed agreement rescission.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAgreementRescissionInput!)

Input fields for updating an agreement rescission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreementRescission (AgreementRescissionType)

The updated agreement rescission instance.

mutation UpdateAgreementRescission($input: UpdateAgreementRescissionInput!) {
  updateAgreementRescission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRescission {
      ...AgreementRescissionTypeFragment
    }
  }
}

{
  "input": UpdateAgreementRescissionInput
}

{
  "data": {
    "updateAgreementRescission": {
      "possibleErrors": [PossibleErrorType],
      "agreementRescission": AgreementRescissionType
    }
  }
}

updateAgreementRollover

Type:UpdateAgreementRollover

Update an agreement rollover.

The possible errors that can be raised are:

KT-CT-4910: No product exists with the given input.
KT-CT-13705: Agreement rollover not found.
KT-CT-13706: Agreement rollover has an invalid status for this operation.
KT-CT-13707: Agreement rollover has an invalid type for this operation.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAgreementRolloverInput!)

Input for updating an agreement rollover.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

agreementRollover (AgreementRolloverType)

The update agreement rollover.

mutation UpdateAgreementRollover($input: UpdateAgreementRolloverInput!) {
  updateAgreementRollover(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

{
  "input": UpdateAgreementRolloverInput
}

{
  "data": {
    "updateAgreementRollover": {
      "possibleErrors": [PossibleErrorType],
      "agreementRollover": AgreementRolloverType
    }
  }
}

updateApiException

Type:UpdateAPIException

Mutation to update an existing APIException instance.

The possible errors that can be raised are:

KT-CT-7804: No fields present in the input for updating the APIException.
KT-CT-7803: Received an invalid apiExceptionId.
KT-CT-7809: Update results in no changes to API Exception.
KT-CT-7805: Too many tags associated with this API Exception.
KT-CT-7806: Cannot create duplicate tags for the same API exception.
KT-CT-7801: Received an invalid operationsTeamId.
KT-CT-7811: Received an invalid assignedUserId.
KT-CT-7812: Support user is inactive.
KT-CT-7814: Received an invalid accountNumber.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAPIExceptionInput!)

Input fields for updating an API exception.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiException (APIExceptionType)

The updated APIException.

mutation UpdateApiException($input: UpdateAPIExceptionInput!) {
  updateApiException(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

{
  "input": UpdateAPIExceptionInput
}

{
  "data": {
    "updateApiException": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

updateApiExceptionNote

Type:UpdateAPIExceptionNote

Mutation to update an existing APIExceptionNote instance.

The possible errors that can be raised are:

KT-CT-7807: Received an invalid apiExceptionNoteId.
KT-CT-7808: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

apiException (APIExceptionType)

The updates APIExceptionNote.

mutation UpdateApiExceptionNote($input: UpdateAPIExceptionNoteInput!) {
  updateApiExceptionNote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

{
  "input": UpdateAPIExceptionNoteInput
}

{
  "data": {
    "updateApiExceptionNote": {
      "possibleErrors": [PossibleErrorType],
      "apiException": APIExceptionType
    }
  }
}

updateAutoTopUpAmount

Type:UpdateAutoTopUpAmount

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

KT-CT-3815: No active payment schedule found for this account.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3953: The payment schedule is not a balance triggered schedule.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3822: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAutoTopUpAmountInput!)

Input fields for updating the auto-top-up amount for a schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

schedule (PaymentScheduleType)

The new schedule created.

mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
  updateAutoTopUpAmount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdateAutoTopUpAmountInput
}

{
  "data": {
    "updateAutoTopUpAmount": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

updateBoostCharge

Update the boost charge for a specific device.

BC_DEVICE_NOT_YET_LIVE (device is not yet live)
BC_DEVICE_RETIRED (device is retired)
BC_DEVICE_SUSPENDED (device is suspended)
BC_DEVICE_DISCONNECTED (device is disconnected)
BC_DEVICE_NOT_AT_HOME (device is not at home)
BC_BOOST_CHARGE_IN_PROGRESS (boost charge already in progress)
BC_DEVICE_FULLY_CHARGED (device is already fully charged)

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4354: Unable to cancel boost charge.
KT-CT-4356: A boost charge cannot currently be performed.
KT-CT-4357: Unable to trigger boost charge.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateBoostChargeInput)

Return fields

Name	Description
`id` (`ID!`)	A UUID that identifies this device registration. Re-registering this device will result in a different ID.
`name` (`String`)	The user-friendly name for the device.
`deviceType` (`KrakenFlexDeviceTypes!`)	The type of device.
`provider` (`ProviderChoices!`)	The third-party that enables control of this device.
`integrationDeviceId` (`String`)	The third-party integration device ID.
`status` (`SmartFlexDeviceStatusInterface!`)	Information about the current status of this device.
`propertyId` (`String`)	The id of the property linked to the device.
`alerts` (`[SmartFlexDeviceAlertInterface]`)	Active alert message(s) for a device, showing the latest first.
`onboardingWizard` (`SmartFlexOnboardingWizard`)	The current onboarding wizard for a device.
`preferences` (`SmartFlexDevicePreferencesInterface`)	The device's preference details.
`preferenceSetting` (`FlexDevicePreferenceSettingInterface`)	The preference setting for this device.
`reAuthenticationState` (`DeviceReAuthenticationInterface`)	The re-authentication state of this device, if applicable.

mutation UpdateBoostCharge($input: UpdateBoostChargeInput) {
  updateBoostCharge(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

{
  "input": UpdateBoostChargeInput
}

{
  "data": {
    "updateBoostCharge": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateCampaignAccountExpiryDate

Type:UpdateCampaignAccountExpiryDate

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-7428: Failed to update campaign account.
KT-CT-7429: No active campaign account found for the given account and campaign.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCampaignAccountExpiryDateInput!)

Input variables needed for updating a campaign account expiry date.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignAccount (AccountCampaignType)

The campaign account with the updated expiry date.

mutation UpdateCampaignAccountExpiryDate($input: UpdateCampaignAccountExpiryDateInput!) {
  updateCampaignAccountExpiryDate(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignAccount {
      ...AccountCampaignTypeFragment
    }
  }
}

{
  "input": UpdateCampaignAccountExpiryDateInput
}

{
  "data": {
    "updateCampaignAccountExpiryDate": {
      "possibleErrors": [PossibleErrorType],
      "campaignAccount": AccountCampaignType
    }
  }
}

updateCollectionProcessRecordToActive

Type:UpdateCollectionProcessRecordToActive

Update the Collection Process Record from raised status to active.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11202: No External reference provided.
KT-CT-11207: Unsupported external source for collection process.
KT-CT-11218: External reference cannot be updated once it has been set.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCollectionProcessRecordToActiveInputType!)

Input variables needed for making a collection process record active.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessActivated (UpdateCollectionProcessRecordToActiveOutputType)

Whether the collection process was successfully updated.

mutation UpdateCollectionProcessRecordToActive($input: UpdateCollectionProcessRecordToActiveInputType!) {
  updateCollectionProcessRecordToActive(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessActivated {
      ...UpdateCollectionProcessRecordToActiveOutputTypeFragment
    }
  }
}

{
  "input": UpdateCollectionProcessRecordToActiveInputType
}

{
  "data": {
    "updateCollectionProcessRecordToActive": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
    }
  }
}

updateCollectionProcessRecordToComplete

Type:UpdateCollectionProcessRecordToComplete

Update the Collection Process Record from raised status to complete.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-11201: No Collection Process Records associated with id.
KT-CT-11203: No Completion reason provided.
KT-CT-11204: No Completion details provided.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCollectionProcessRecordToCompleteInputType!)

Input variables needed for making a collection process record complete.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

collectionProcessComplete (UpdateCollectionProcessRecordToCompleteOutputType)

Whether the collection process was successfully updated.

mutation UpdateCollectionProcessRecordToComplete($input: UpdateCollectionProcessRecordToCompleteInputType!) {
  updateCollectionProcessRecordToComplete(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    collectionProcessComplete {
      ...UpdateCollectionProcessRecordToCompleteOutputTypeFragment
    }
  }
}

{
  "input": UpdateCollectionProcessRecordToCompleteInputType
}

{
  "data": {
    "updateCollectionProcessRecordToComplete": {
      "possibleErrors": [PossibleErrorType],
      "collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
    }
  }
}

updateCommsDeliveryPreference

Type:UpdateCommsDeliveryPreference

Update account communication delivery preference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4136: Cannot set comms preference to email when account has no email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountInterface)

mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
  updateCommsDeliveryPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateCommsDeliveryPreferenceInput
}

{
  "data": {
    "updateCommsDeliveryPreference": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateCommsHubStatus

Type:UpdateCommsHubStatus

Update the status of the CHF (Communictions Hub).

The possible errors that can be raised are:

KT-GB-4026: Either the mpxn or mpan input must be provided.
KT-GB-4027: If both mpxn and mpan are provided, they must match.
KT-GB-4028: Please input a valid MPxN.
KT-GB-4029: Meter point not found for MPAN.
KT-GB-4030: Meter point not found for MPRN.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCommsHubStatusInput!)

Input fields for updating the status of the communications hub.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

requestReference (String)

The id of the Request object in Kraken.

mutation UpdateCommsHubStatus($input: UpdateCommsHubStatusInput!) {
  updateCommsHubStatus(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    requestReference
  }
}

{
  "input": UpdateCommsHubStatusInput
}

{
  "data": {
    "updateCommsHubStatus": {
      "possibleErrors": [PossibleErrorType],
      "requestReference": "abc123"
    }
  }
}

updateCommsPreferences

Type:UpdateAccountUserCommsPreferencesMutationPayload

Update the comms preferences of the account user (the authenticated user).

Arguments

Name Description

input (UpdateAccountUserCommsPreferencesMutationInput!)

Return fields

Name	Description
`isOptedInToClientMessages` (`Boolean`)
`isOptedInToOfferMessages` (`Boolean`)
`isOptedInToRecommendedMessages` (`Boolean`)
`isOptedInToUpdateMessages` (`Boolean`)
`isOptedInToThirdPartyMessages` (`Boolean`)
`isOptedInMeterReadingConfirmations` (`Boolean`)
`isOptedInToSmsMessages` (`Boolean`)
`isUsingInvertedEmailColours` (`Boolean`)
`fontSizeMultiplier` (`Float`)
`emailFormat` (`String`)
`preferredHoldMusic` (`String`)
`errors` (`[ErrorType]`)
`commsPreferences` (`AccountUserCommsPreferences`)
`clientMutationId` (`String`)

mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
  updateCommsPreferences(input: $input) {
    isOptedInToClientMessages
    isOptedInToOfferMessages
    isOptedInToRecommendedMessages
    isOptedInToUpdateMessages
    isOptedInToThirdPartyMessages
    isOptedInMeterReadingConfirmations
    isOptedInToSmsMessages
    isUsingInvertedEmailColours
    fontSizeMultiplier
    emailFormat
    preferredHoldMusic
    errors {
      ...ErrorTypeFragment
    }
    commsPreferences {
      ...AccountUserCommsPreferencesFragment
    }
    clientMutationId
  }
}

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

{
  "data": {
    "updateCommsPreferences": {
      "isOptedInToClientMessages": true,
      "isOptedInToOfferMessages": true,
      "isOptedInToRecommendedMessages": true,
      "isOptedInToUpdateMessages": true,
      "isOptedInToThirdPartyMessages": true,
      "isOptedInMeterReadingConfirmations": true,
      "isOptedInToSmsMessages": true,
      "isUsingInvertedEmailColours": true,
      "fontSizeMultiplier": 1.0,
      "emailFormat": "abc123",
      "preferredHoldMusic": "abc123",
      "errors": [ErrorType],
      "commsPreferences": AccountUserCommsPreferences,
      "clientMutationId": "abc123"
    }
  }
}

updateDcaProceeding

Type:UpdateDCAProceeding

Update the status of a DCA proceeding.

The possible errors that can be raised are:

KT-CT-11610: unable to edit the debt collection proceeding.
KT-CT-11604: Active debt collection proceeding does not exist for account.
KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateDCAProceedingInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

dcaProceedingUpdateStatus (DCAProceedingUpdateStatus)

Whether the update has been applied.

mutation UpdateDcaProceeding($input: UpdateDCAProceedingInputType!) {
  updateDcaProceeding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    dcaProceedingUpdateStatus {
      ...DCAProceedingUpdateStatusFragment
    }
  }
}

{
  "input": UpdateDCAProceedingInputType
}

{
  "data": {
    "updateDcaProceeding": {
      "possibleErrors": [PossibleErrorType],
      "dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
    }
  }
}

updateDeviceGridExport

Update the grid export preference for a device.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4386: An error occurred while trying to update your device's grid export status.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateDeviceGridExportInput)

Return fields

Name	Description
`id` (`ID!`)	A UUID that identifies this device registration. Re-registering this device will result in a different ID.
`name` (`String`)	The user-friendly name for the device.
`deviceType` (`KrakenFlexDeviceTypes!`)	The type of device.
`provider` (`ProviderChoices!`)	The third-party that enables control of this device.
`integrationDeviceId` (`String`)	The third-party integration device ID.
`status` (`SmartFlexDeviceStatusInterface!`)	Information about the current status of this device.
`propertyId` (`String`)	The id of the property linked to the device.
`alerts` (`[SmartFlexDeviceAlertInterface]`)	Active alert message(s) for a device, showing the latest first.
`onboardingWizard` (`SmartFlexOnboardingWizard`)	The current onboarding wizard for a device.
`preferences` (`SmartFlexDevicePreferencesInterface`)	The device's preference details.
`preferenceSetting` (`FlexDevicePreferenceSettingInterface`)	The preference setting for this device.
`reAuthenticationState` (`DeviceReAuthenticationInterface`)	The re-authentication state of this device, if applicable.

mutation UpdateDeviceGridExport($input: UpdateDeviceGridExportInput) {
  updateDeviceGridExport(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

{
  "input": UpdateDeviceGridExportInput
}

{
  "data": {
    "updateDeviceGridExport": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateDeviceSmartControl

Suspends or resumes the smart control of a specific device. For some devices, this will also adjust smart control of related devices. e.g. suspending one zone in a multi-zone heat pump system will suspend all zones in that system.

The possible errors that can be raised are:

KT-CT-4313: Could not find KrakenFlex device.
KT-CT-4314: Unable to get provider details.
KT-CT-4387: Could not find the KrakenFlex controller device.
KT-CT-4358: Unable to suspend device control.
KT-CT-4359: Unable to resume device control.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SmartControlInput!)

The input to action the desired device control, i.e. suspend or unsuspend a device.

Return fields

Name	Description
`id` (`ID!`)	A UUID that identifies this device registration. Re-registering this device will result in a different ID.
`name` (`String`)	The user-friendly name for the device.
`deviceType` (`KrakenFlexDeviceTypes!`)	The type of device.
`provider` (`ProviderChoices!`)	The third-party that enables control of this device.
`integrationDeviceId` (`String`)	The third-party integration device ID.
`status` (`SmartFlexDeviceStatusInterface!`)	Information about the current status of this device.
`propertyId` (`String`)	The id of the property linked to the device.
`alerts` (`[SmartFlexDeviceAlertInterface]`)	Active alert message(s) for a device, showing the latest first.
`onboardingWizard` (`SmartFlexOnboardingWizard`)	The current onboarding wizard for a device.
`preferences` (`SmartFlexDevicePreferencesInterface`)	The device's preference details.
`preferenceSetting` (`FlexDevicePreferenceSettingInterface`)	The preference setting for this device.
`reAuthenticationState` (`DeviceReAuthenticationInterface`)	The re-authentication state of this device, if applicable.

mutation UpdateDeviceSmartControl($input: SmartControlInput!) {
  updateDeviceSmartControl(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

{
  "input": SmartControlInput
}

{
  "data": {
    "updateDeviceSmartControl": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateDocumentAccessibilityPreference

Type:UpdateDocumentAccessibilityPreference!

Update the document accessibility preference for an account.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateDocumentAccessibilityPreferenceInput!)

Input fields for updating document accessibility preference for an account.

Return fields

Name	Description

mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
  updateDocumentAccessibilityPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": UpdateDocumentAccessibilityPreferenceInput
}

{
  "data": {
    "updateDocumentAccessibilityPreference": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

updateIsChargingDurationCapped

Update the charging duration cap preference for a device.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4389: An error occurred while trying to update your device's isChargingDurationCapped setting.
KT-CT-4390: An error occurred while trying to update your device's preference.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateIsChargingDurationCappedInput)

Input fields for updating the charging duration cap preference.

Return fields

Name	Description
`id` (`ID!`)	A UUID that identifies this device registration. Re-registering this device will result in a different ID.
`name` (`String`)	The user-friendly name for the device.
`deviceType` (`KrakenFlexDeviceTypes!`)	The type of device.
`provider` (`ProviderChoices!`)	The third-party that enables control of this device.
`integrationDeviceId` (`String`)	The third-party integration device ID.
`status` (`SmartFlexDeviceStatusInterface!`)	Information about the current status of this device.
`propertyId` (`String`)	The id of the property linked to the device.
`alerts` (`[SmartFlexDeviceAlertInterface]`)	Active alert message(s) for a device, showing the latest first.
`onboardingWizard` (`SmartFlexOnboardingWizard`)	The current onboarding wizard for a device.
`preferences` (`SmartFlexDevicePreferencesInterface`)	The device's preference details.
`preferenceSetting` (`FlexDevicePreferenceSettingInterface`)	The preference setting for this device.
`reAuthenticationState` (`DeviceReAuthenticationInterface`)	The re-authentication state of this device, if applicable.

mutation UpdateIsChargingDurationCapped($input: UpdateIsChargingDurationCappedInput) {
  updateIsChargingDurationCapped(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

{
  "input": UpdateIsChargingDurationCappedInput
}

{
  "data": {
    "updateIsChargingDurationCapped": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateLeadAssignment

Type:UpdateLeadAssignment

Update assignment fields for a Lead.

The possible errors that can be raised are:

KT-CT-8907: Lead not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateLeadAssignmentInput!)

Fields for updating a lead assignment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

updatedLeadData (JSONString)

Arguments passed.

mutation UpdateLeadAssignment($input: UpdateLeadAssignmentInput!) {
  updateLeadAssignment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

{
  "input": UpdateLeadAssignmentInput
}

{
  "data": {
    "updateLeadAssignment": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadDetails

Type:UpdateLeadDetails

Update the details of a lead.

The possible errors that can be raised are:

KT-CT-8907: Lead not found.
KT-CT-8912: Funnel not found.
KT-CT-8931: Extra detail value is invalid.
KT-CT-8935: National ID bad input.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateLeadDetailsInput!)

Fields for updating a lead's details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

updatedLeadData (JSONString)

Arguments passed.

mutation UpdateLeadDetails($input: UpdateLeadDetailsInput!) {
  updateLeadDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

{
  "input": UpdateLeadDetailsInput
}

{
  "data": {
    "updateLeadDetails": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadStage

Type:UpdateLeadStage

Update the stage of a lead.

The possible errors that can be raised are:

KT-CT-8907: Lead not found.
KT-CT-8914: Stage not found.
KT-CT-8915: Stages are not in the same funnel.
KT-CT-8916: Current stage mismatch.
KT-CT-8917: Stage transition not allowed.
KT-CT-8918: Stage precondition not met.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateLeadStageInput!)

Fields for updating a lead's stage.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

updatedLeadData (JSONString)

Arguments passed.

mutation UpdateLeadStage($input: UpdateLeadStageInput!) {
  updateLeadStage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedLeadData
  }
}

{
  "input": UpdateLeadStageInput
}

{
  "data": {
    "updateLeadStage": {
      "possibleErrors": [PossibleErrorType],
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeaveSupplier

Type:LeaveSupplierUpdated!

Update an existing leave supplier process.

The possible errors that can be raised are:

KT-CT-10304: Mutation not enabled in this environment.
KT-CT-10302: Invalid data.
KT-CT-10309: Failed to update leave supplier process - the service is not enabled.
KT-CT-10310: Failed to update leave supplier process. The process status is not in updatable status.
KT-CT-1607: Value cannot be empty.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateLeaveSupplierInput!)

Return fields

Name	Description

mutation UpdateLeaveSupplier($input: UpdateLeaveSupplierInput!) {
  updateLeaveSupplier(input: $input) {
    message
  }
}

{
  "input": UpdateLeaveSupplierInput
}

{
  "data": {
    "updateLeaveSupplier": {
      "message": "abc123"
    }
  }
}

updateMessageTags

Type:UpdateMessageTags

The possible errors that can be raised are:

KT-CT-7611: The message was not found.
KT-CT-7614: The Ink tag was not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateMessageTagsInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

tags ([InkTag!]!)

Confirmed tags.

mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
  updateMessageTags(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    tags {
      ...InkTagFragment
    }
  }
}

{
  "input": UpdateMessageTagsInput
}

{
  "data": {
    "updateMessageTags": {
      "possibleErrors": [PossibleErrorType],
      "tags": InkTag
    }
  }
}

updateMetadata

Type:UpdateMetadata

Update metadata on an object.

The possible errors that can be raised are:

KT-CT-4323: Unauthorized.
KT-CT-8413: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MetadataInput!)

Input fields for updating metadata.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

metadata (Metadata)

mutation UpdateMetadata($input: MetadataInput!) {
  updateMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": MetadataInput
}

{
  "data": {
    "updateMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

updateNotesOnOpportunity

Type:UpdateNotesOnOpportunity

Update the notes of an opportunity.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateNotesOnOpportunityInput!)

Input to update the note on an opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

opportunityNumber (String)

The number of the opportunity.

mutation UpdateNotesOnOpportunity($input: UpdateNotesOnOpportunityInput!) {
  updateNotesOnOpportunity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
  }
}

{
  "input": UpdateNotesOnOpportunityInput
}

{
  "data": {
    "updateNotesOnOpportunity": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "abc123"
    }
  }
}

updateOfferGroupOnOpportunity

Type:UpdateOfferGroupOnOpportunity

Update the offer group of an opportunity.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateOfferGroupOnOpportunityInput!)

Input to update the offer group on an opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

opportunityNumber (String)

The number of the opportunity.

mutation UpdateOfferGroupOnOpportunity($input: UpdateOfferGroupOnOpportunityInput!) {
  updateOfferGroupOnOpportunity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    opportunityNumber
  }
}

{
  "input": UpdateOfferGroupOnOpportunityInput
}

{
  "data": {
    "updateOfferGroupOnOpportunity": {
      "possibleErrors": [PossibleErrorType],
      "opportunityNumber": "abc123"
    }
  }
}

updateOnSiteJobsAppointment

Type:UpdateOnSiteJobsAppointment

Update an Appointment.

The possible errors that can be raised are:

KT-CT-13001: Appointment does not exist.
KT-CT-13043: Cannot update appointment as it has terminal status.
KT-CT-13044: Failed to update appointment slot.
KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
KT-CT-13039: Cancellation fields require CANCELLED status.
KT-CT-13045: Failed to update appointment assets.
KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
KT-CT-13051: Supply point not found when creating assets.
KT-CT-13052: Multiple supply points found when creating assets.
KT-CT-13062: Datetime field must be timezone-aware.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OnSiteJobsUpdateAppointmentInput!)

The appointment and its details to update.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The Appointment that was updated.

mutation UpdateOnSiteJobsAppointment($input: OnSiteJobsUpdateAppointmentInput!) {
  updateOnSiteJobsAppointment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

{
  "input": OnSiteJobsUpdateAppointmentInput
}

{
  "data": {
    "updateOnSiteJobsAppointment": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

updateOnSiteJobsRequest

Type:UpdateOnSiteJobsRequest

Update an On Site Jobs Request.

The possible errors that can be raised are:

KT-CT-13032: Request does not exist.
KT-CT-13035: Request is inactive.
KT-CT-13038: Invalid request status.
KT-CT-13040: Agent not set on request.
KT-CT-13045: Failed to update appointment assets.
KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_id when creating assets.
KT-CT-13051: Supply point not found when creating assets.
KT-CT-13052: Multiple supply points found when creating assets.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (OnSiteJobsUpdateRequestInput!)

The input objects required to update a Request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

onSiteJobsRequest (OnSiteJobsRequestType)

The updated request.

mutation UpdateOnSiteJobsRequest($input: OnSiteJobsUpdateRequestInput!) {
  updateOnSiteJobsRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

{
  "input": OnSiteJobsUpdateRequestInput
}

{
  "data": {
    "updateOnSiteJobsRequest": {
      "possibleErrors": [PossibleErrorType],
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

updateOpportunityAssignment

Type:UpdateOpportunityAssignment

Update assignment fields for an Opportunity.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-8903: Unable to update opportunity.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateOpportunityAssignmentInput!)

Input fields for creating an opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

updatedOpportunityData (JSONString)

Arguments passed.

mutation UpdateOpportunityAssignment($input: UpdateOpportunityAssignmentInput!) {
  updateOpportunityAssignment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedOpportunityData
  }
}

{
  "input": UpdateOpportunityAssignmentInput
}

{
  "data": {
    "updateOpportunityAssignment": {
      "possibleErrors": [PossibleErrorType],
      "updatedOpportunityData": {"key": "value"}
    }
  }
}

updateOpportunityDetails

Type:UpdateOpportunityDetails

Update the details of an opportunity.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-8930: Unable to parse address.
KT-CT-8931: Extra detail value is invalid.
KT-CT-8912: Funnel not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateOpportunityDetailsInput!)

Input fields for updating the address of a opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

updatedData (JSONString)

Arguments updated.

mutation UpdateOpportunityDetails($input: UpdateOpportunityDetailsInput!) {
  updateOpportunityDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    updatedData
  }
}

{
  "input": UpdateOpportunityDetailsInput
}

{
  "data": {
    "updateOpportunityDetails": {
      "possibleErrors": [PossibleErrorType],
      "updatedData": {"key": "value"}
    }
  }
}

updateOpportunityExtraDetails

Type:UpdateOpportunityExtraDetails

Update the extra details of a opportunity.

The possible errors that can be raised are:

KT-CT-8906: Opportunity not found.
KT-CT-8926: Unable to create opportunity.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateExtraDetailsInput!)

Input fields for updating the extra details of a opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

extraDetails (JSONString)

The opportunity's extra details to be added or updated.

mutation UpdateOpportunityExtraDetails($input: UpdateExtraDetailsInput!) {
  updateOpportunityExtraDetails(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    extraDetails
  }
}

{
  "input": UpdateExtraDetailsInput
}

{
  "data": {
    "updateOpportunityExtraDetails": {
      "possibleErrors": [PossibleErrorType],
      "extraDetails": {"key": "value"}
    }
  }
}

updateOpportunityStage

Type:UpdateOpportunityStage

Update the stage of a opportunity.

The possible errors that can be raised are:

KT-CT-8903: Unable to update opportunity.
KT-CT-8910: Received opportunity current stage is not valid.
KT-CT-8914: Stage not found.
KT-CT-8915: Stages are not in the same funnel.
KT-CT-8916: Current stage mismatch.
KT-CT-8917: Stage transition not allowed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateOpportunityStageInput!)

Input fields for updating the state of a opportunity.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

message (String)

Placeholder success message for now.

mutation UpdateOpportunityStage($input: UpdateOpportunityStageInput!) {
  updateOpportunityStage(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    message
  }
}

{
  "input": UpdateOpportunityStageInput
}

{
  "data": {
    "updateOpportunityStage": {
      "possibleErrors": [PossibleErrorType],
      "message": "abc123"
    }
  }
}

updatePassword

Type:UpdatePassword

Update password of the authenticated user.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5460: Old password is invalid.
KT-CT-5450: Password is invalid.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdatePasswordInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

mutation UpdatePassword($input: UpdatePasswordInput) {
  updatePassword(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdatePasswordInput
}

{
  "data": {
    "updatePassword": {
      "possibleErrors": [PossibleErrorType],
      "viewer": AccountUserType
    }
  }
}

updatePaymentSchedulePaymentAmount

Type:UpdatePaymentSchedulePaymentAmount

Update monthly Direct Debit payment amount. Enter amount in pence

Lower limit: 100p (£1), Upper limit: 100,000p (£1,000)

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-3919: Invalid payment schedule amount.
KT-GB-3920: Cannot update payment schedule amount.
KT-CT-3922: Ledger not found for the account.
KT-CT-3923: Unauthorized.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdatePaymentSchedulePaymentAmountInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentSchedule (PaymentScheduleType)

mutation UpdatePaymentSchedulePaymentAmount($input: UpdatePaymentSchedulePaymentAmountInput!) {
  updatePaymentSchedulePaymentAmount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdatePaymentSchedulePaymentAmountInput
}

{
  "data": {
    "updatePaymentSchedulePaymentAmount": {
      "possibleErrors": [PossibleErrorType],
      "paymentSchedule": PaymentScheduleType
    }
  }
}

updatePaymentSchedulePaymentDay

Type:UpdatePaymentSchedulePaymentDay

Update monthly Direct Debit payment day. Permitted values: 1-28. Not available for business accounts

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-3918: Account not found.
KT-GB-3910: This feature is not available to business accounts.
KT-GB-3911: Your payment day cannot be changed at this time.
KT-GB-3912: Unable to update payment day.
KT-CT-3922: Ledger not found for the account.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdatePaymentSchedulePaymentDayInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentSchedule (PaymentScheduleType)

mutation UpdatePaymentSchedulePaymentDay($input: UpdatePaymentSchedulePaymentDayInput!) {
  updatePaymentSchedulePaymentDay(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdatePaymentSchedulePaymentDayInput
}

{
  "data": {
    "updatePaymentSchedulePaymentDay": {
      "possibleErrors": [PossibleErrorType],
      "paymentSchedule": PaymentScheduleType
    }
  }
}

updateProductPrices

Type:UpdateProductPricesOutput!

Update the prices of a product.

The possible errors that can be raised are:

KT-CT-12008: Unable to find the product.
KT-CT-12009: Specified product does not have a specification.
KT-CT-12010: Unable to find the product's specification.
KT-CT-12011: The list of provided prices contains validation errors.
KT-CT-12012: Product prices start date is in the past.
KT-CT-12013: Product prices would overwrite existing prices.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateProductPricesInput!)

Return fields

Name	Description

mutation UpdateProductPrices($input: UpdateProductPricesInput!) {
  updateProductPrices(input: $input) {
    prices {
      ...RateGroupPricesFragment
    }
  }
}

{
  "input": UpdateProductPricesInput
}

{
  "data": {
    "updateProductPrices": {
      "prices": RateGroupPrices
    }
  }
}

updateSensorDisplayName

Type:UpdateSensorDisplayName

Update the display name of a sensor.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name	Description
`accountNumber` (`String!`)	The account number.
`displayName` (`String!`)	The new display name.
`euid` (`ID!`)	The EUID of the heat pump controller.
`sensorCode` (`String!`)	The code of the sensor to rename (such as 'SENSOR01').

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with updating a sensor attribute.

mutation UpdateSensorDisplayName(
  $accountNumber: String!,
  $displayName: String!,
  $euid: ID!,
  $sensorCode: String!
) {
  updateSensorDisplayName(
    accountNumber: $accountNumber,
    displayName: $displayName,
    euid: $euid,
    sensorCode: $sensorCode
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "displayName": "abc123",
  "euid": "abc123",
  "sensorCode": "abc123"
}

{
  "data": {
    "updateSensorDisplayName": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

updateSiteworksRequest

Type:UpdateSiteworksRequest

Update a Request.

The possible errors that can be raised are:

KT-CT-4231: Unauthorized.
KT-CT-4232: Status passed is not valid.
KT-CT-4233: Request does not exist.
KT-CT-4234: Terminated Request cannot be updated.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'updateSiteworksRequest' field is deprecated.

Please use updateOnSiteJobsRequest instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Arguments

Name Description

input (UpdateSiteworksRequestInputType!)

The input objects required to update a Request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

siteworksRequest (CoreSiteworksRequestType)

The siteworks request after the update.

mutation UpdateSiteworksRequest($input: UpdateSiteworksRequestInputType!) {
  updateSiteworksRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    siteworksRequest {
      ...CoreSiteworksRequestTypeFragment
    }
  }
}

{
  "input": UpdateSiteworksRequestInputType
}

{
  "data": {
    "updateSiteworksRequest": {
      "possibleErrors": [PossibleErrorType],
      "siteworksRequest": CoreSiteworksRequestType
    }
  }
}

updateSmartMeterDataPreferences

Type:UpdateSmartMeterDataPreferences

Update smart meter data preferences of an account. Includes updating reading frequency and readings analysis consent.

The possible errors that can be raised are:

KT-CT-4023: Unauthorized.
KT-GB-4015: Cannot update smart meter reading frequency preferences.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateSmartMeterDataPreferencesInput!)

Input fields for updating smart meter data preferences.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

preferencesUpdated (Boolean)

smartMeterDataPreferences (SmartMeterDataPreferencesType)

mutation UpdateSmartMeterDataPreferences($input: UpdateSmartMeterDataPreferencesInput!) {
  updateSmartMeterDataPreferences(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    preferencesUpdated
    smartMeterDataPreferences {
      ...SmartMeterDataPreferencesTypeFragment
    }
  }
}

{
  "input": UpdateSmartMeterDataPreferencesInput
}

{
  "data": {
    "updateSmartMeterDataPreferences": {
      "possibleErrors": [PossibleErrorType],
      "preferencesUpdated": true,
      "smartMeterDataPreferences": SmartMeterDataPreferencesType
    }
  }
}

updateSpecialCircumstances

Type:UpdateSpecialCircumstances

Update or create special circumstances for the user, which may entitle them to specialist services

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-5411: Failed to update special circumstance record.
KT-CT-9404: Received an invalid accountUserId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateSpecialCircumstancesInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

specialCircumstances (SpecialCircumstancesType)

Return type displaying an AccountUser's special circumstances.

mutation UpdateSpecialCircumstances($input: UpdateSpecialCircumstancesInput!) {
  updateSpecialCircumstances(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
  }
}

{
  "input": UpdateSpecialCircumstancesInput
}

{
  "data": {
    "updateSpecialCircumstances": {
      "possibleErrors": [PossibleErrorType],
      "specialCircumstances": SpecialCircumstancesType
    }
  }
}

updateSpecialCircumstancesAsOrganization

Type:UpdateSpecialCircumstancesAsOrganization

Update or create special circumstances by an organisation on behalf of a user

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-5411: Failed to update special circumstance record.
KT-CT-9404: Received an invalid accountUserId.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateSpecialCircumstancesAsOrganizationInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

specialCircumstances (SpecialCircumstancesType)

Return type displaying an AccountUser's special circumstances.

mutation UpdateSpecialCircumstancesAsOrganization($input: UpdateSpecialCircumstancesAsOrganizationInput!) {
  updateSpecialCircumstancesAsOrganization(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
  }
}

{
  "input": UpdateSpecialCircumstancesAsOrganizationInput
}

{
  "data": {
    "updateSpecialCircumstancesAsOrganization": {
      "possibleErrors": [PossibleErrorType],
      "specialCircumstances": SpecialCircumstancesType
    }
  }
}

updateSsd

Type:UpdateSsd

Update SSD.

The possible errors that can be raised are:

KT-GB-4101: Unable to update SSD for account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateSsdInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

ssdUpdated (Boolean)

estimatedSsd (Date)

mutation UpdateSsd($input: UpdateSsdInput) {
  updateSsd(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    ssdUpdated
    estimatedSsd
  }
}

{
  "input": UpdateSsdInput
}

{
  "data": {
    "updateSsd": {
      "possibleErrors": [PossibleErrorType],
      "ssdUpdated": true,
      "estimatedSsd": "2020-01-01"
    }
  }
}

updateSupplyPointMetadata

Type:UpdateSupplyPointMetadata

Update metadata for a supply point.

The possible errors that can be raised are:

KT-CT-8413: Invalid data.
KT-CT-8415: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SupplyPointMetadataInput!)

Input fields for updating metadata.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

metadata (Metadata)

The updated metadata.

mutation UpdateSupplyPointMetadata($input: SupplyPointMetadataInput!) {
  updateSupplyPointMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": SupplyPointMetadataInput
}

{
  "data": {
    "updateSupplyPointMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

updateUser

Type:UpdateUserMutation

Update the account user details of the authenticated user. Email address changes are silently ignored for OEGB clients.

The possible errors that can be raised are:

KT-CT-5413: Invalid data.
KT-CT-5414: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateUserInput!)

Input fields for updating user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

viewer (AccountUserType)

mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdateUserInput
}

{
  "data": {
    "updateUser": {
      "possibleErrors": [PossibleErrorType],
      "viewer": AccountUserType
    }
  }
}

updateUserDetails

Type:UpdateAccountUserMutationPayload

DEPRECATED: Please use updateUser instead

Update the account user details of the authenticated user. Only one field can be updated per day. This prevents users from switching accounts to someone else (usually when moving homes) All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.

Deprecated

The 'updateUserDetails' field is deprecated.

Please use the 'updateUser' mutation instead.

- Marked as deprecated on 2020-10-02.
- Scheduled for removal on or after 2023-04-06.

Arguments

Name Description

input (UpdateAccountUserMutationInput!)

Return fields

Name	Description
`givenName` (`String`)
`familyName` (`String`)
`pronouns` (`String`)
`mobile` (`String`)
`email` (`String`)
`dateOfBirth` (`Date`)
`landline` (`String`)
`errors` (`[ErrorType]`)
`clientMutationId` (`String`)

mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
  updateUserDetails(input: $input) {
    givenName
    familyName
    pronouns
    mobile
    email
    dateOfBirth
    landline
    errors {
      ...ErrorTypeFragment
    }
    clientMutationId
  }
}

{
  "input": UpdateAccountUserMutationInput
}

{
  "data": {
    "updateUserDetails": {
      "givenName": "abc123",
      "familyName": "abc123",
      "pronouns": "abc123",
      "mobile": "abc123",
      "email": "abc123",
      "dateOfBirth": "2020-01-01",
      "landline": "abc123",
      "errors": [ErrorType],
      "clientMutationId": "abc123"
    }
  }
}

updateWaterSetpoint

Type:UpdateWaterSetpoint

Set the temperature for the hot water.

The possible errors that can be raised are:

KT-CT-4321: Serializer validation error.
KT-CT-1113: Disabled GraphQL field requested.

Deprecated

Arguments

Name Description

accountNumber (String!)

The account number.

euid (ID!)

The EUID of the heat pump controller.

setpoint (Int!)

The temperature to set the water to.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

transactionId (ID)

Unique ID associated with this operation.

mutation UpdateWaterSetpoint(
  $accountNumber: String!,
  $euid: ID!,
  $setpoint: Int!
) {
  updateWaterSetpoint(
    accountNumber: $accountNumber,
    euid: $euid,
    setpoint: $setpoint
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    transactionId
  }
}

{
  "accountNumber": "abc123",
  "euid": "abc123",
  "setpoint": 1
}

{
  "data": {
    "updateWaterSetpoint": {
      "possibleErrors": [PossibleErrorType],
      "transactionId": "abc123"
    }
  }
}

validateEmail

Type:ValidateEmail

Validate user's email address.

Arguments

Name Description

input (ValidateEmailInput!)

Return fields

Name Description

isValid (Boolean)

Whether the email is valid or not.

mutation ValidateEmail($input: ValidateEmailInput!) {
  validateEmail(input: $input) {
    isValid
  }
}

{
  "input": ValidateEmailInput
}

{
  "data": {
    "validateEmail": {
      "isValid": true
    }
  }
}

validateMfaDevice

Type:ValidateMfaDevice

Validate MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1151: MFA device not found.
KT-CT-1152: Invalid MFA token.
KT-CT-1155: Enabled backup device is needed.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

Input fields for validating a new multi-factor authentication device for the logged user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

deviceIsValid (Boolean)

Flag to indicate if the device has been verified, so it can be used for MFA.

mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
  validateMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceIsValid
  }
}

{
  "input": ValidateMfaDeviceInputType
}

{
  "data": {
    "validateMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceIsValid": true
    }
  }
}

validatePhone

Type:ValidatePhone

Validate user's phone number.

Arguments

Name Description

input (ValidatePhoneNumberInput!)

Return fields

Name Description

isValid (Boolean)

Whether the phone number is valid or not.

mutation ValidatePhone($input: ValidatePhoneNumberInput!) {
  validatePhone(input: $input) {
    isValid
  }
}

{
  "input": ValidatePhoneNumberInput
}

{
  "data": {
    "validatePhone": {
      "isValid": true
    }
  }
}

varyContractTerms

Type:VaryContractTermsOutput!

Vary the terms of a contract.

The possible errors that can be raised are:

KT-CT-10003: Contract not found.
KT-CT-10008: The contract is currently undergoing an active journey.
KT-CT-10011: Unable to vary contract terms.
KT-CT-10033: Unable to save term.
KT-CT-10012: Contract variation implies breach.
KT-CT-10034: Unknown contract journey type.
KT-CT-10035: Cannot process a non-active contract journey.
KT-CT-10036: The contract journey manager is not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (VaryContractTermsInput!)

Return fields

Name	Description

mutation VaryContractTerms($input: VaryContractTermsInput!) {
  varyContractTerms(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

{
  "input": VaryContractTermsInput
}

{
  "data": {
    "varyContractTerms": {
      "contract": Contract
    }
  }
}

verifyCustomer

Type:VerifyCustomer

Verify a customer using the provided verification code and type.

The possible errors that can be raised are:

KT-CT-4191: Error while verifying the customer.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (VerifyCustomerInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

user (AccountUserType)

The currently authenticated user.

mutation VerifyCustomer($input: VerifyCustomerInput!) {
  verifyCustomer(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    user {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": VerifyCustomerInput
}

{
  "data": {
    "verifyCustomer": {
      "possibleErrors": [PossibleErrorType],
      "user": AccountUserType
    }
  }
}

verifyEmail

Type:VerifyEmail

Verify user's email address.

The possible errors that can be raised are:

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (VerifyEmailInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

isVerified (Boolean)

Whether the email is verified.

mutation VerifyEmail($input: VerifyEmailInput!) {
  verifyEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    isVerified
  }
}

{
  "input": VerifyEmailInput
}

{
  "data": {
    "verifyEmail": {
      "possibleErrors": [PossibleErrorType],
      "isVerified": true
    }
  }
}

verifyIdentity

Type:VerifyIdentity

Provide identifying information about an account and user to get a scoped token that will permit access to associate an email address with the account's user.

The possible errors that can be raised are:

KT-CT-1145: Account/user details do not match.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (VerifyIdentityInput!)

Details about the user to be verified.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (String!)

An expiring token that can be used to request to update the user's email address.

mutation VerifyIdentity($input: VerifyIdentityInput!) {
  verifyIdentity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

{
  "input": VerifyIdentityInput
}

{
  "data": {
    "verifyIdentity": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123"
    }
  }
}

withdrawDunning

Type:WithdrawDunning