Mutations

In this section

About Mutations

Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

API Site

acceptGoodsQuote

Type: AcceptGoodsQuote

URL: https://api.oeg-kraken.energy/v1/graphql/

Accept a goods quote.

The possible errors that can be raised are:

Arguments

Name Description

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

Name Description

goodsPurchase (GoodsPurchase)

Goods purchase created.

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.

Mutation

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

Variables

{
  "input": AcceptGoodsQuoteInput
}

Response

{
  "data": {
    "acceptGoodsQuote": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

acceptOfferForQuoting

Type: AcceptOfferForQuoting

URL: https://api.oeg-kraken.energy/v1/graphql/

Accept a quoting offer in an offer group.

The possible errors that can be raised are:

Arguments

Name Description

input (AcceptOfferForQuotingInput!)

Input fields for accepting a quoting offer.

Return fields

Name Description

offer (OfferType)

Accepted quoting offer.

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.

Mutation

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

Variables

{
  "input": AcceptOfferForQuotingInput
}

Response

{
  "data": {
    "acceptOfferForQuoting": {
      "offer": OfferType
    }
  }
}

actualizeContract

Type: ActualizeContractOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Actualize a contract for an account or business.

The possible errors that can be raised are:

Arguments

Name Description

input (ActualizeContractInput!)

Return fields

Name Description

contract (Contract)

The contract actualized.

Mutation

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

Variables

{
  "input": ActualizeContractInput
}

Response

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

addBusinessToSegment

Type: AddBusinessToSegmentMutation

URL: https://api.oeg-kraken.energy/v1/graphql/

Add a business to a segment.

The possible errors that can be raised are:

Arguments

Name Description

input (AddBusinessToSegmentInput!)

Input fields for adding a business to a segment.

Return fields

Name Description

businessSegmentPeriod (BusinessSegmentPeriodType)

The business segment period that was created.

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.

Mutation

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

Variables

{
  "input": AddBusinessToSegmentInput
}

Response

{
  "data": {
    "addBusinessToSegment": {
      "businessSegmentPeriod": BusinessSegmentPeriodType
    }
  }
}

addCampaignToAccount

Type: AddCampaignToAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

Name Description

campaignAdded (Boolean)

Whether the campaign was successfully added.

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.

Mutation

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

Variables

{
  "input": AddCampaignToAccountInput
}

Response

{
  "data": {
    "addCampaignToAccount": {
      "campaignAdded": true
    }
  }
}

addChildToProperty

Type: AddChildToProperty

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (AddChildToPropertyInput!)

Input fields for adding a child to a parent property.

Return fields

Name Description

child (PropertyType)

The child property that was added to the parent.

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.

Mutation

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

Variables

{
  "input": AddChildToPropertyInput
}

Response

{
  "data": {
    "addChildToProperty": {
      "child": PropertyType
    }
  }
}

addItemsToRiskList

Type: AddItemsToRiskList

URL: https://api.oeg-kraken.energy/v1/graphql/

Add items to the risk list.

The possible errors that can be raised are:

Arguments

Name Description

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

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.

riskIdentifiers ([RiskListItemType])

List of successfully added risk identifiers.

Mutation

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

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "addItemsToRiskList": {
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

addNoteToInkConversation

Type: AddNoteToInkConversation

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (AddNoteToInkConversationInput)

Return fields

Name Description

note (InkNote)

The ink conversation note.

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.

Mutation

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

Variables

{
  "input": AddNoteToInkConversationInput
}

Response

{
  "data": {
    "addNoteToInkConversation": {
      "note": InkNote
    }
  }
}

addParentToProperty

Type: AddParentToProperty

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (AddParentToPropertyInput!)

Input fields for adding a parent to a child property.

Return fields

Name Description

parent (PropertyType)

The parent property that was added to the child.

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.

Mutation

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

Variables

{
  "input": AddParentToPropertyInput
}

Response

{
  "data": {
    "addParentToProperty": {
      "parent": PropertyType
    }
  }
}

addPortfolioReference

Type: AddPortfolioReference

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to add a reference to an existing portfolio.

The possible errors that can be raised are:

Arguments

Name Description

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

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.

Mutation

mutation AddPortfolioReference($input: AddPortfolioReferenceInput) {
  addPortfolioReference(input: $input) {
  }
}

Variables

{
  "input": AddPortfolioReferenceInput
}

Response

{
  "data": {
    "addPortfolioReference": {

    }
  }
}

addProperty

Type: AddProperty

URL: https://api.oeg-kraken.energy/v1/graphql/

Add a property to an account.

The possible errors that can be raised are:

Arguments

Name Description

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

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.

property (PropertyType)

The property that was added to the account.

Mutation

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

Variables

{
  "input": AddPropertyInput
}

Response

{
  "data": {
    "addProperty": {
      "property": PropertyType
    }
  }
}

addPropertyToHierarchy

Type: AddPropertyToHierarchy

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

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

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.

property (PropertyType)

The property that was added to the hierarchy.

Mutation

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

Variables

{
  "input": AddPropertyToHierarchyInput
}

Response

{
  "data": {
    "addPropertyToHierarchy": {
      "property": PropertyType
    }
  }
}

addSignupReferralOnAccount

Type: AddSignupReferralOnAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

Add a one-way signup reward to a referral.

The possible errors that can be raised are:

Arguments

Name Description

input (AddSignupReferralOnAccountInput!)

Input fields for creating a signup reward for an organization.

Return fields

Name Description

accountReferral (ReferralType)

The created account referral instance.

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.

Mutation

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

Variables

{
  "input": AddSignupReferralOnAccountInput
}

Response

{
  "data": {
    "addSignupReferralOnAccount": {
      "accountReferral": ReferralType
    }
  }
}

addStorylineToInkConversation

Type: AddStorylineToInkConversation

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (AddStorylineToInkConversationInput)

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.

storyline (InkStoryline)

The storyline that was added to the conversation.

Mutation

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

Variables

{
  "input": AddStorylineToInkConversationInput
}

Response

{
  "data": {
    "addStorylineToInkConversation": {
      "storyline": InkStoryline
    }
  }
}

addUserToPortfolio

Type: AddUserToPortfolio

URL: https://api.oeg-kraken.energy/v1/graphql/

Add an user to a portfolio with a specified role.

The possible errors that can be raised are:

Arguments

Name Description

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

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.

Mutation

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

Variables

{
  "input": AddUserToPortfolioInput
}

Response

{
  "data": {
    "addUserToPortfolio": {

    }
  }
}

allowRepaymentSubmission

Type: AllowRepaymentSubmission

URL: https://api.oeg-kraken.energy/v1/graphql/

Allow a repayment to be submitted.

The possible errors that can be raised are:

Arguments

Name Description

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

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.

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

Mutation

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

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "allowRepaymentSubmission": {
      "repaymentId": "47182330",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

amendPayment

Type: AmendPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Amend an existing payment.

The possible errors that can be raised are:

Arguments

Name Description

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

Name Description

payment (AccountPaymentType)

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.

Mutation

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

Variables

{
  "input": AmendPaymentInput
}

Response

{
  "data": {
    "amendPayment": {
      "payment": AccountPaymentType
    }
  }
}

annulOrder

Type: AnnulOrder

URL: https://api.oeg-kraken.energy/v1/graphql/

Annul an order before a supply start date has been received.

The possible errors that can be raised are:

Arguments

Name Description

input (AnnulOrderInput!)

Input variables needed for annulling the order.

Return fields

Name Description

orderAnnulled (Boolean)

Whether the order annulment was successful.

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.

Mutation

mutation AnnulOrder($input: AnnulOrderInput!) {
  annulOrder(input: $input) {
    orderAnnulled
  }
}

Variables

{
  "input": AnnulOrderInput
}

Response

{
  "data": {
    "annulOrder": {
      "orderAnnulled": true
    }
  }
}

approveRepayment

Type: ApproveRepayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Approve a repayment.

The possible errors that can be raised are:

Arguments

Name Description

input (ApproveRepaymentInput!)

Input fields for approving a repayment.

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.

repayment (AccountRepaymentType)

The approved repayment.

Mutation

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

Variables

{
  "input": ApproveRepaymentInput
}

Response

{
  "data": {
    "approveRepayment": {
      "repayment": AccountRepaymentType
    }
  }
}

assessCollectionProcessRecordForPause

Type: AssessCollectionProcessRecordForPause

URL: https://api.oeg-kraken.energy/v1/graphql/

Assess a collection process record for pause.

The possible errors that can be raised are:

Arguments

Name Description

input (AssessCollectionProcessRecordForPauseInputType!)

Details of collection process to run the pause assessment.

Return fields

Name Description

collectionProcessProcessed (AssessCollectionProcessRecordForPauseOutputType)

Details of collection process after running the pause assessment.

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.

Mutation

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

Variables

{
  "input": AssessCollectionProcessRecordForPauseInputType
}

Response

{
  "data": {
    "assessCollectionProcessRecordForPause": {
      "collectionProcessProcessed": AssessCollectionProcessRecordForPauseOutputType
    }
  }
}

assignInkBucket

Type: AssignInkBucket

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (AssignInkBucketInput)

Return fields

Name Description

bucket (InkBucket!)

The bucket that the conversation will be assigned to.

conversation (InkConversation!)

The conversation that will be assigned to the bucket.

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.

Mutation

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

Variables

{
  "input": AssignInkBucketInput
}

Response

{
  "data": {
    "assignInkBucket": {
      "bucket": InkBucket,
      "conversation": InkConversation
    }
  }
}

assignSupplyPointToEstimationGroup

Type: AssignSupplyPointToEstimationGroup

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

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

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.

supplyPointEstimationGroup (AssignedSupplyPointEstimationGroupType)

The created supply point estimation group mapping.

Mutation

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

Variables

{
  "input": AssignSupplyPointToEstimationGroupInput
}

Response

{
  "data": {
    "assignSupplyPointToEstimationGroup": {
      "supplyPointEstimationGroup": AssignedSupplyPointEstimationGroupType
    }
  }
}

associateCallWithAccount

Type: AssociateCallWithAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (AssociateCallWithAccountInput!)

Return fields

Name Description

call (InboundCallType)

The call.

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.

Mutation

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

Variables

{
  "input": AssociateCallWithAccountInput
}

Response

{
  "data": {
    "associateCallWithAccount": {
      "call": InboundCallType
    }
  }
}

associateItemToCollectionProcess

Type: AssociateItemToCollectionProcess

URL: https://api.oeg-kraken.energy/v1/graphql/

Associate item to a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (AssociateItemToCollectionProcessInputType!)

Input variables needed for associating an item to collection process.

Return fields

Name Description

collectionProcessAssociatedItem (AssociateItemToCollectionProcessOutputType)

Item associated to the collection process.

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.

Mutation

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

Variables

{
  "input": AssociateItemToCollectionProcessInputType
}

Response

{
  "data": {
    "associateItemToCollectionProcess": {
      "collectionProcessAssociatedItem": AssociateItemToCollectionProcessOutputType
    }
  }
}

awardLoyaltyPoints

Type: AwardLoyaltyPoints

URL: https://api.oeg-kraken.energy/v1/graphql/

Award the passed number of Loyalty Points to the account.

The possible errors that can be raised are:

Arguments

Name Description

input (AwardLoyaltyPointsInput!)

Input fields for awarding Loyalty Points.

Return fields

Name Description

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the awarded loyalty points.

pointsAwarded (Int)

The number of loyalty points that were awarded.

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.

Mutation

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

Variables

{
  "input": AwardLoyaltyPointsInput
}

Response

{
  "data": {
    "awardLoyaltyPoints": {
      "ledgerEntry": LoyaltyPointLedgerEntryType,
      "pointsAwarded": 56
    }
  }
}

backendScreenEvent

Type: BackendScreenEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

Name Description

action (ActionType)

An action to perform.

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.

Mutation

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

Variables

{
  "input": BackendScreenEventInput
}

Response

{
  "data": {
    "backendScreenEvent": {
      "action": DeeplinkActionType
    }
  }
}

blockRepaymentSubmission

Type: BlockRepaymentSubmission

URL: https://api.oeg-kraken.energy/v1/graphql/

Block a repayment from being submitted.

The possible errors that can be raised are:

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

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.

repaymentId (ID)

The repayment ID.

repaymentIntervention (RepaymentInterventionType)

Resulting Repayment Intervention details.

Mutation

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

Variables

{
  "input": RepaymentInput
}

Response

{
  "data": {
    "blockRepaymentSubmission": {
      "repaymentId": "87380828",
      "repaymentIntervention": RepaymentInterventionType
    }
  }
}

cancelContract

Type: CancelContract

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel contract from the customer and send a confirmation email.

Arguments

Name Description

input (CancelContractInput!)

Input variables needed for cancelling the contract.

Return fields

Name Description

cancelledContract (Boolean)

Whether the contract cancellation was successful.

lastDayOfSupply (Date)

The last day of supply.

Mutation

mutation CancelContract($input: CancelContractInput!) {
  cancelContract(input: $input) {
    cancelledContract
    lastDayOfSupply
  }
}

Variables

{
  "input": CancelContractInput
}

Response

{
  "data": {
    "cancelContract": {
      "cancelledContract": true,
      "lastDayOfSupply": "1973-08-27"
    }
  }
}

cancelEnrollment

Type: EnrollmentCancelled!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (CancelEnrollmentInput!)

Return fields

Name Description

enrollmentProcess (EnrollmentProcess!)

The Enrollment process that was cancelled.

message (String!)

The message to display to the user on Enrollment initiation.

Mutation

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

Variables

{
  "input": CancelEnrollmentInput
}

Response

{
  "data": {
    "cancelEnrollment": {
      "enrollmentProcess": JoinSupplierProcessType,
      "message": "but-seven-painting-moment-business"
    }
  }
}

cancelLeaveSupplier

Type: LeaveSupplierCancelled!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

message (String!)

The message to display to the user on cancellation.

Mutation

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

Variables

{
  "input": CancelLeaveSupplierInput
}

Response

{
  "data": {
    "cancelLeaveSupplier": {
      "message": "sound-people-often-room-fear"
    }
  }
}

cancelOnSiteJobsAppointment

Type: CancelOnSiteJobsAppointment

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel an Appointment.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelOnSiteJobsAppointmentInputType!)

The input objects required to cancel an Appointment.

Return fields

Name Description

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The Appointment that was cancelled.

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.

Mutation

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

Variables

{
  "input": CancelOnSiteJobsAppointmentInputType
}

Response

{
  "data": {
    "cancelOnSiteJobsAppointment": {
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

cancelPayment

Type: CancelPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel an in-flight payment.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelPaymentInput!)

Input fields for cancelling a pending payment.

Return fields

Name Description

payment (AccountPaymentType)

The cancelled payment.

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.

Mutation

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

Variables

{
  "input": CancelPaymentInput
}

Response

{
  "data": {
    "cancelPayment": {
      "payment": AccountPaymentType
    }
  }
}

cancelRepaymentRequest

Type: CancelRepaymentRequest

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel a repayment or refund request.

The possible errors that can be raised are:

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

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.

repaymentRequest (CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

Mutation

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

Variables

{
  "input": CancelRepaymentRequestInputType
}

Response

{
  "data": {
    "cancelRepaymentRequest": {
      "repaymentRequest": CancelRepaymentRequestOutputType
    }
  }
}

cancelSmartFlexOnboarding

Type: CancelSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel onboarding of a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (CancelSmartFlexOnboardingInput!)

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

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

Variables

{
  "input": CancelSmartFlexOnboardingInput
}

Response

{
  "data": {
    "cancelSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

closeDcaProceeding

Type: CloseDCAProceeding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

dcaProceedingClosureStatus (DCAProceedingClosureStatus)

Whether the closure could be applied.

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.

Mutation

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

Variables

{
  "input": CloseDCAProceedingInputType
}

Response

{
  "data": {
    "closeDcaProceeding": {
      "dcaProceedingClosureStatus": DCAProceedingClosureStatus
    }
  }
}

closeInkConversation

Type: CloseInkConversation

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CloseInkConversationInput)

Input for closing an Ink conversation.

Return fields

Name Description

conversation (InkConversation)

The conversation that was closed.

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.

Mutation

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

Variables

{
  "input": CloseInkConversationInput
}

Response

{
  "data": {
    "closeInkConversation": {
      "conversation": InkConversation
    }
  }
}

closeInkLiveChat

Type: CloseInkLiveChatConversation

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CloseInkLiveChaConversationtInput)

Return fields

Name Description

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

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.

Mutation

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

Variables

{
  "input": CloseInkLiveChaConversationtInput
}

Response

{
  "data": {
    "closeInkLiveChat": {
      "liveChatConversation": InkLiveChatConversation
    }
  }
}

closeOpenPrintBatch

Type: CloseOpenPrintBatch!

URL: https://api.oeg-kraken.energy/v1/graphql/

Close the Open Print Batch if any.

The possible errors that can be raised are:

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.

printBatch (PrintBatchType)

Mutation

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

Response

{
  "data": {
    "closeOpenPrintBatch": {
      "printBatch": PrintBatchType
    }
  }
}

collectDeposit

Type: CollectDeposit

URL: https://api.oeg-kraken.energy/v1/graphql/

Collect deposit for the given account.

The possible errors that can be raised are:

Arguments

Name Description

input (CollectDepositInput!)

Return fields

Name Description

payment (CollectDepositOutput)

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.

Mutation

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

Variables

{
  "input": CollectDepositInput
}

Response

{
  "data": {
    "collectDeposit": {
      "payment": CollectDepositOutput
    }
  }
}

collectPayment

Type: CollectPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

Name Description

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.

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.

Mutation

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

Variables

{
  "input": CollectPaymentInput
}

Response

{
  "data": {
    "collectPayment": {
      "payment": AccountPaymentType
    }
  }
}

commenceDcaProceeding

Type: CommenceDCAProceeding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

dcaProceedingCommencementStatus (DCAProceedingCommencementStatus)

Whether the commencement could be applied.

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.

Mutation

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

Variables

{
  "input": CommenceDCAProceedingInputType
}

Response

{
  "data": {
    "commenceDcaProceeding": {
      "dcaProceedingCommencementStatus": DCAProceedingCommencementStatus
    }
  }
}

completeAuthFlowForSmartFlexOnboarding

Type: CompleteAuthFlowForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

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

Variables

{
  "input": CompleteAuthFlowInput
}

Response

{
  "data": {
    "completeAuthFlowForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeStandalonePayment

Type: CompleteStandalonePayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Complete a standalone payment.

The possible errors that can be raised are:

Arguments

Name Description

input (CompleteStandalonePaymentInput!)

Input fields for completing a standalone payment.

Return fields

Name Description

payment (CompleteStandalonePaymentOutput)

The completed standalone payment.

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.

Mutation

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

Variables

{
  "input": CompleteStandalonePaymentInput
}

Response

{
  "data": {
    "completeStandalonePayment": {
      "payment": CompleteStandalonePaymentOutput
    }
  }
}

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type: CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

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

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

{
  "data": {
    "completeTeslaSetupVirtualKeyForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserActionForSmartFlexOnboarding

Type: CompleteUserActionRequiredForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

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

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

{
  "data": {
    "completeUserActionForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeUserInputRequiredForSmartFlexOnboarding

Type: CompleteUserInputRequiredForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

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

Variables

{
  "input": UserInputRequiredInput
}

Response

{
  "data": {
    "completeUserInputRequiredForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

confirmDoubleOptIn

Type: ConfirmDoubleOptIn

URL: https://api.oeg-kraken.energy/v1/graphql/

Confirm a double opt in

The possible errors that can be raised are:

Arguments

Name Description

input (ConfirmDoubleOptInInput)

Return fields

Name Description

consent (ConsentType)

The consent that was created or updated.

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.

Mutation

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

Variables

{
  "input": ConfirmDoubleOptInInput
}

Response

{
  "data": {
    "confirmDoubleOptIn": {
      "consent": ConsentType
    }
  }
}

connectAiAgentToCall

Type: ConnectAiAgentToCall

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (ConnectAiAgentToCallInput!)

Return fields

Name Description

call (InboundCallType)

The call the AI agent was connected to.

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.

Mutation

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

Variables

{
  "input": ConnectAiAgentToCallInput
}

Response

{
  "data": {
    "connectAiAgentToCall": {
      "call": InboundCallType
    }
  }
}

createAccountCharge

Type: CreateAccountCharge

URL: https://api.oeg-kraken.energy/v1/graphql/

Add charge to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountChargeInput!)

Input fields for creating an account charge.

Return fields

Name Description

accountCharge (AccountChargeType)

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.

Mutation

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

Variables

{
  "input": CreateAccountChargeInput
}

Response

{
  "data": {
    "createAccountCharge": {
      "accountCharge": AccountChargeType
    }
  }
}

createAccountCredit

Type: CreateAccountCredit

URL: https://api.oeg-kraken.energy/v1/graphql/

Add credit to an account.

The possible errors that can be raised are:

Deprecated

The 'createAccountCredit' field is deprecated.

Use postCredit mutation as it is ledger aware.

- Marked as deprecated on 2022-07-04.
- Scheduled for removal on or after 2024-01-01.

Arguments

Name Description

input (CreateAccountCreditInput!)

Input fields for creating an account credit.

Return fields

Name Description

accountCredit (AccountCreditType)

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.

Mutation

mutation CreateAccountCredit($input: CreateAccountCreditInput!) {
  createAccountCredit(input: $input) {
    accountCredit {
      ...AccountCreditTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountCreditInput
}

Response

{
  "data": {
    "createAccountCredit": {
      "accountCredit": AccountCreditType
    }
  }
}

createAccountNote

Type: CreateAccountNote

URL: https://api.oeg-kraken.energy/v1/graphql/

Add a note to an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAccountNoteInput!)

Input variables needed for adding a note to an account.

Return fields

Name Description

account (AccountType)

Account, which has the added note.

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.

Mutation

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

Variables

{
  "input": CreateAccountNoteInput
}

Response

{
  "data": {
    "createAccountNote": {
      "account": AccountType
    }
  }
}

createAccountPaymentSchedule

Type: CreateAccountPaymentSchedule

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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.

schedule (PaymentScheduleType!)

New payment schedule.

Mutation

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

Variables

{
  "input": CreateAccountPaymentScheduleInput
}

Response

{
  "data": {
    "createAccountPaymentSchedule": {
      "schedule": PaymentScheduleType
    }
  }
}

createAccountReference

Type: CreateAccountReference

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

Name Description

accountReference (AccountReferenceType)

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.

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

{
  "data": {
    "createAccountReference": {
      "accountReference": AccountReferenceType
    }
  }
}

createAccountReminder

Type: CreateAccountReminder

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an account reminder.

The possible errors that can be raised are:

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

accountReminder (AccountReminder)

Account reminder.

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.

Mutation

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

Variables

{
  "input": CreateAccountReminderInput
}

Response

{
  "data": {
    "createAccountReminder": {
      "accountReminder": AccountReminder
    }
  }
}

Type: CreateAffiliateLink!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an affiliate link for a new sales agent.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAffiliateLinkInputType!)

Input fields for creating an affiliate link for an organisation.

Return fields

Name Description

affiliateLink (AffiliateLinkType)

The created affiliate link.

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.

Mutation

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

Variables

{
  "input": CreateAffiliateLinkInputType
}

Response

{
  "data": {
    "createAffiliateLink": {
      "affiliateLink": AffiliateLinkType
    }
  }
}

createAffiliateOrganisation

Type: CreateAffiliateOrganisation!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an affiliate organisation.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAffiliateOrganisationInputType!)

Input fields for creating an affiliate organisation.

Return fields

Name Description

affiliateOrganisation (AffiliateOrganisationType)

The created affiliate organisation.

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.

Mutation

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

Variables

{
  "input": CreateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "createAffiliateOrganisation": {
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

Arguments

Name Description

input (CreateAffiliateSessionInputType!)

Input fields for creating a session for an affiliate link.

Return fields

Name Description

affiliateSession (AffiliateSessionType)

The created affiliate session.

Mutation

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

Variables

{
  "input": CreateAffiliateSessionInputType
}

Response

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

createAgreement

Type: CreateAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a new agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAgreementInput!)

Input fields for creating an agreement.

Return fields

Name Description

agreement (CommonAgreementType)

The created agreement.

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.

Mutation

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

Variables

{
  "input": CreateAgreementInput
}

Response

{
  "data": {
    "createAgreement": {
      "agreement": CommonAgreementType
    }
  }
}

createAgreementRollover

Type: CreateAgreementRollover

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an agreement rollover for a specific account and agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAgreementRolloverInput!)

Create an agreement rollover for a specific account and agreement.

Return fields

Name Description

agreementRollover (AgreementRolloverType)

The new agreement rollover.

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.

Mutation

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

Variables

{
  "input": CreateAgreementRolloverInput
}

Response

{
  "data": {
    "createAgreementRollover": {
      "agreementRollover": AgreementRolloverType
    }
  }
}

createApiCall

Type: CreateAPICall

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to create a new APICall instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPICallInput!)

Input fields for creating an API call.

Return fields

Name Description

apiCall (APICallType)

The created APICall.

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.

Mutation

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

Variables

{
  "input": CreateAPICallInput
}

Response

{
  "data": {
    "createApiCall": {
      "apiCall": APICallType
    }
  }
}

createApiException

Type: CreateAPIException

URL: https://api.oeg-kraken.energy/v1/graphql/

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

apiException (APIExceptionType)

The created APIException.

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.

Mutation

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

Variables

{
  "input": CreateAPIExceptionInput
}

Response

{
  "data": {
    "createApiException": {
      "apiException": APIExceptionType
    }
  }
}

createApiExceptionEvent

Type: CreateAPIExceptionEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to create a new APIExceptionEvent instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPIExceptionEventInput!)

Input fields for creating an API exception event.

Return fields

Name Description

apiExceptionEvent (APIExceptionEventType)

The created APIExceptionEvent.

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.

Mutation

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

Variables

{
  "input": CreateAPIExceptionEventInput
}

Response

{
  "data": {
    "createApiExceptionEvent": {
      "apiExceptionEvent": APIExceptionEventType
    }
  }
}

createApiExceptionNote

Type: CreateAPIExceptionNote

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to create a new APIExceptionNote instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

apiException (APIExceptionType)

The created APIExceptionNote.

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.

Mutation

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

Variables

{
  "input": CreateAPIExceptionNoteInput
}

Response

{
  "data": {
    "createApiExceptionNote": {
      "apiException": APIExceptionType
    }
  }
}

createAudioRecording

Type: CreateAudioRecording!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an audio recording for an affiliate session.

The possible errors that can be raised are:

Arguments

Name Description

input (AudioRecordingInputType!)

Input fields required to create an audio recording.

Return fields

Name Description

audioRecording (AudioRecordingType)

The created audio recording.

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.

Mutation

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

Variables

{
  "input": AudioRecordingInputType
}

Response

{
  "data": {
    "createAudioRecording": {
      "audioRecording": AudioRecordingType
    }
  }
}

createBusiness

Type: CreateBusiness

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a business.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateBusinessInput!)

Input for creating a business.

Return fields

Name Description

business (BusinessType)

The created business.

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.

Mutation

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

Variables

{
  "input": CreateBusinessInput
}

Response

{
  "data": {
    "createBusiness": {
      "business": BusinessType
    }
  }
}

createCallMetadata

Type: CreateCallMetadata

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CallMetadataInput!)

Return fields

Name Description

call (CallInterface)

The call metadata was attached to.

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.

Mutation

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

Variables

{
  "input": CallMetadataInput
}

Response

{
  "data": {
    "createCallMetadata": {
      "call": CallInterface
    }
  }
}

createCampaignItems

Type: CreateCampaignItems

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCampaignItemsInput!)

Return fields

Name Description

batchIdentifier (String)

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

campaignItems ([VoiceCampaignItemType])

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.

Mutation

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

Variables

{
  "input": CreateCampaignItemsInput
}

Response

{
  "data": {
    "createCampaignItems": {
      "batchIdentifier": "68668329",
      "campaignItems": [VoiceCampaignItemType]
    }
  }
}

createCollectionProcessEvent

Type: CreateCollectionProcessEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an event for a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCollectionProcessEventInputType!)

Input variables needed for creating a collection process event.

Return fields

Name Description

collectionProcessEvent (CollectionProcessEventOutputType)

The created collection process event.

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.

Mutation

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

Variables

{
  "input": CreateCollectionProcessEventInputType
}

Response

{
  "data": {
    "createCollectionProcessEvent": {
      "collectionProcessEvent": CollectionProcessEventOutputType
    }
  }
}

createComplaint

Type: CreateComplaint

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a complaint.

The possible errors that can be raised are:

Arguments

Name Description

complaint (CreateComplaintInputType!)

Return fields

Name Description

complaint (ComplaintType)

The complaint that has been created.

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.

Mutation

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

Variables

{
  "complaint": CreateComplaintInputType
}

Response

{
  "data": {
    "createComplaint": {
      "complaint": ComplaintType
    }
  }
}

createContract

Type: CreateContractOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateContractInput!)

Return fields

Name Description

identifier (NonEmptyString)

Unique identifier for the created contract.

wasCreated (Boolean!)

Indicates whether a new contract was created (True) or an existing contract was matched (False). When False, the mutation is idempotent and returns the existing contract that matches the provided parameters.

Mutation

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

Variables

{
  "input": CreateContractInput
}

Response

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

createContributionAgreement

Type: CreateContributionAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a contribution agreement for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateContributionAgreementInput!)

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

Return fields

Name Description

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

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.

Mutation

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

Variables

{
  "input": CreateContributionAgreementInput
}

Response

{
  "data": {
    "createContributionAgreement": {
      "contributionAgreement": ContributionAgreementType
    }
  }
}

createCreditTransferPermission

Type: CreateCreditTransferPermission

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a credit transfer permission.

The possible errors that can be raised are:

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

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.

validFrom (DateTime)

Datetime when the credit transfer permission is valid.

Mutation

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

Variables

{
  "input": CreateCreditTransferPermissionInput
}

Response

{
  "data": {
    "createCreditTransferPermission": {
      "validFrom": "1993-12-19T07:16:29.567588+00:00"
    }
  }
}

createCustomerFeedback

Type: CreateCustomerFeedback

URL: https://api.oeg-kraken.energy/v1/graphql/

Create unsubmitted customer feedback object.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateCustomerFeedbackInputType!)

Return fields

Name Description

customerFeedback (CustomerFeedbackType)

The created customer feedback object.

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.

Mutation

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

Variables

{
  "input": CreateCustomerFeedbackInputType
}

Response

{
  "data": {
    "createCustomerFeedback": {
      "customerFeedback": CustomerFeedbackType
    }
  }
}

createDepositAgreement

Type: CreateDepositAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateDepositAgreementInput!)

Return fields

Name Description

depositAgreement (CreateDepositAgreementOutput)

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.

Mutation

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

Variables

{
  "input": CreateDepositAgreementInput
}

Response

{
  "data": {
    "createDepositAgreement": {
      "depositAgreement": CreateDepositAgreementOutput
    }
  }
}

createElectricityMeterReadings

Type: CreateElectricityMeterReadings

URL: https://api.oeg-kraken.energy/v1/graphql/

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

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (ReadingsInput!)

Input fields for creating meter readings for a customer.

Return fields

Name Description

numberOfReadingsCreated (Int)

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.

readingDate (Date)

Mutation

mutation CreateElectricityMeterReadings($input: ReadingsInput!) {
  createElectricityMeterReadings(input: $input) {
    numberOfReadingsCreated
    readingDate
  }
}

Variables

{
  "input": ReadingsInput
}

Response

{
  "data": {
    "createElectricityMeterReadings": {
      "numberOfReadingsCreated": 17,
      "readingDate": "2006-03-22"
    }
  }
}

createExternalAccountEvent

Type: CreateExternalAccountEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an external account event.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateExternalAccountEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

event (ExternalAccountEvent)

The new event data.

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.

Mutation

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

Variables

{
  "input": CreateExternalAccountEventInput
}

Response

{
  "data": {
    "createExternalAccountEvent": {
      "event": ExternalAccountEvent
    }
  }
}

createExternalAccountUserEvent

Type: CreateExternalAccountUserEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an external account user event.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateExternalAccountUserEventInput!)

Input fields for creating an external account event.

Return fields

Name Description

event (ExternalAccountUserEvent)

The new event data.

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.

Mutation

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

Variables

{
  "input": CreateExternalAccountUserEventInput
}

Response

{
  "data": {
    "createExternalAccountUserEvent": {
      "event": ExternalAccountUserEvent
    }
  }
}

createExternalMessage

Type: CreateExternalMessage

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (CreateExternalMessageInput!)

Input variables needed for creating an external message.

Return fields

Name Description

externalMessage (ExternalMessageType)

The external message that was created.

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.

Mutation

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

Variables

{
  "input": CreateExternalMessageInput
}

Response

{
  "data": {
    "createExternalMessage": {
      "externalMessage": ExternalMessageType
    }
  }
}

createFormSubmission

Type: FormSubmissionOuput

URL: https://api.oeg-kraken.energy/v1/graphql/

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

content (JSONString)

errors ([SerializerFieldErrorsType])

id (Int)

Mutation

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

Variables

{
  "input": FormSubmissionInput
}

Response

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

createGasMeterReadings

Type: CreateGasMeterReadings

URL: https://api.oeg-kraken.energy/v1/graphql/

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

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (ReadingsInput!)

Input fields for creating meter readings for a customer.

Return fields

Name Description

numberOfReadingsCreated (Int)

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.

readingDate (Date)

Mutation

mutation CreateGasMeterReadings($input: ReadingsInput!) {
  createGasMeterReadings(input: $input) {
    numberOfReadingsCreated
    readingDate
  }
}

Variables

{
  "input": ReadingsInput
}

Response

{
  "data": {
    "createGasMeterReadings": {
      "numberOfReadingsCreated": 8,
      "readingDate": "1983-12-10"
    }
  }
}

createGoodsPurchase

Type: CreateGoodsPurchase

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a goods purchase.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

Name Description

goodsPurchase (GoodsPurchase)

Goods purchase created.

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.

Mutation

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

Variables

{
  "input": CreatePurchaseInput
}

Response

{
  "data": {
    "createGoodsPurchase": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

createGoodsQuote

Type: CreateGoodsQuote

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a goods quote.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

Name Description

goodsQuote (GoodsQuote)

Goods quote created for the customer.

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.

Mutation

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

Variables

{
  "input": CreateGoodsQuoteInput
}

Response

{
  "data": {
    "createGoodsQuote": {
      "goodsQuote": GoodsQuote
    }
  }
}

createGoodsQuoteWithoutAccount

Type: CreateGoodsQuoteWithoutAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a goods quote without an account.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateGoodsQuoteWithoutAccountInput!)

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

Return fields

Name Description

goodsQuote (GoodsQuote)

Goods quote created for the customer.

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.

Mutation

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

Variables

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

Response

{
  "data": {
    "createGoodsQuoteWithoutAccount": {
      "goodsQuote": GoodsQuote
    }
  }
}

createInboundCall

Type: CreateInboundCall

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInboundCallInput!)

Return fields

Name Description

call (InboundCallType)

The call that was created.

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.

Mutation

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

Variables

{
  "input": CreateInboundCallInput
}

Response

{
  "data": {
    "createInboundCall": {
      "call": InboundCallType
    }
  }
}

createInkInboundMessage

Type: CreateInkInboundMessage

URL: https://api.oeg-kraken.energy/v1/graphql/

Register an Ink inbound message.

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

message (InkMessage!)

The Ink message that was created.

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.

Mutation

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

Variables

{
  "input": CreateInkInboundMessageInput
}

Response

{
  "data": {
    "createInkInboundMessage": {
      "message": InkEmail
    }
  }
}

createInkLiveChatMessage

Type: CreateInkLiveChatMessage

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (CreateInkLiveChatMessageInput)

Return fields

Name Description

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

messageRelayId (String!)

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

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.

Mutation

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

Variables

{
  "input": CreateInkLiveChatMessageInput
}

Response

{
  "data": {
    "createInkLiveChatMessage": {
      "liveChatConversation": InkLiveChatConversation,
      "messageRelayId": "32094608"
    }
  }
}

createLead

Type: CreateLead

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateLeadInput!)

Input fields for creating a lead.

Return fields

Name Description

leadNumber (String)

The unique number of the lead.

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.

Mutation

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

Variables

{
  "input": CreateLeadInput
}

Response

{
  "data": {
    "createLead": {
      "leadNumber": "enough-dinner-choose-compare-their"
    }
  }
}

createMetadata

Type: CreateMetadata

URL: https://api.oeg-kraken.energy/v1/graphql/

Create metadata on an object.

The possible errors that can be raised are:

Arguments

Name Description

input (MetadataInput!)

Input fields for creating metadata.

Return fields

Name Description

metadata (Metadata)

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.

Mutation

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

Variables

{
  "input": MetadataInput
}

Response

{
  "data": {
    "createMetadata": {
      "metadata": Metadata
    }
  }
}

createMfaDevice

Type: CreateMfaDevice

URL: https://api.oeg-kraken.energy/v1/graphql/

Create MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateMfaDeviceInputType!)

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

Return fields

Name Description

deviceEmail (String)

Email address to send the MFA code by default.

devicePhone (String)

Phone number to send the MFA code by default.

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.

totpSecret (String)

Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually.

Mutation

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

Variables

{
  "input": CreateMfaDeviceInputType
}

Response

{
  "data": {
    "createMfaDevice": {
      "deviceEmail": "yard-technology-notice-long-somebody",
      "devicePhone": "company-street-let-it-whether",
      "totpSecret": "pressure-might-husband-newspaper-leave"
    }
  }
}

createNewAgreementFromProductSwitchProcess

Type: CreateNewAgreementFromProductSwitchProcess

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a new agreement from an existing product switch process.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateNewAgreementFromProductSwitchProcessInput!)

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

Return fields

Name Description

agreement (CommonAgreementType)

The new agreement created.

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.

Mutation

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

Variables

{
  "input": CreateNewAgreementFromProductSwitchProcessInput
}

Response

{
  "data": {
    "createNewAgreementFromProductSwitchProcess": {
      "agreement": CommonAgreementType
    }
  }
}

createNewsletterSignup

Type: CreateNewsletterSignupOutput

URL: https://api.oeg-kraken.energy/v1/graphql/

Creates a new signup for the OEDE newsletter via Maileon API.

Arguments

Name Description

email (String!)

firstName (String)

Return fields

Name Description

content (String)

id (String)

Mutation

mutation CreateNewsletterSignup(
  $email: String!,
  $firstName: String
) {
  createNewsletterSignup(
    email: $email,
    firstName: $firstName
  ) {
    content
    id
  }
}

Variables

{
  "email": "sport-people-require-writer-take",
  "firstName": "generation-station-third-me-simply"
}

Response

{
  "data": {
    "createNewsletterSignup": {
      "content": "series-outside-floor-fast-responsibility",
      "id": "51199160"
    }
  }
}

createOfferGroupForQuoting

Type: CreateOfferGroupForQuoting

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a quoting Offer Group.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOfferGroupForQuotingInput!)

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

Return fields

Name Description

offerGroup (CreateOfferGroupType)

Quoting Offer Group.

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.

Mutation

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

Variables

{
  "input": CreateOfferGroupForQuotingInput
}

Response

{
  "data": {
    "createOfferGroupForQuoting": {
      "offerGroup": CreateOfferGroupType
    }
  }
}

createOnSiteJobsAppointment

Type: CreateOnSiteJobsAppointment

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an Appointment.

The possible errors that can be raised are:

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

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

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.

Mutation

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

Variables

{
  "appointmentBookingSessionId": "327a77f2-5544-49c0-98b5-1d801c19f020",
  "slotId": "da510687-1c29-4fbd-a482-b32f5a055f6c"
}

Response

{
  "data": {
    "createOnSiteJobsAppointment": {
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsAppointmentWithDate

Type: CreateOnSiteJobsAppointmentWithDate

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

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.

Mutation

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

Variables

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "deadlineDate": "2012-07-19",
  "overrideAppointmentCheckWarnings": true,
  "preferredDate": "1981-07-31",
  "requestId": "653907fa-d408-4bfc-a85f-fbfd1b399dbf"
}

Response

{
  "data": {
    "createOnSiteJobsAppointmentWithDate": {
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsAppointmentWithoutBooking

Type: CreateOnSiteJobsAppointmentWithoutBooking

URL: https://api.oeg-kraken.energy/v1/graphql/

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 cancellation_category/cancellation_sub_category.
  • KT-CT-13039: Cancellation fields require CANCELLED status.
  • KT-CT-13027: Booking system error occurred.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_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 (OnSiteJobsCreateAppointmentInput!)

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

Return fields

Name Description

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The created Appointment.

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.

Mutation

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

Variables

{
  "input": OnSiteJobsCreateAppointmentInput
}

Response

{
  "data": {
    "createOnSiteJobsAppointmentWithoutBooking": {
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

createOnSiteJobsRequest

Type: CreateOnSiteJobsRequest

URL: https://api.oeg-kraken.energy/v1/graphql/

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-13005: Supply points must belong to the same property.
  • 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-13010: No booking adapter found for agent.
  • KT-CT-13011: Appointment with the given external reference and agent already exists for a different request.
  • 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 supply_point_identifier_to_market_name_mapping and supply_point_internal_ids.
  • KT-CT-13049: Neither supply_point_identifier_to_market_name_mapping nor supply_point_internal_ids provided.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_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-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

onSiteJobsRequest (OnSiteJobsRequestType)

The created request.

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.

Mutation

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

Variables

{
  "input": CreateOnSiteJobsRequestInputType
}

Response

{
  "data": {
    "createOnSiteJobsRequest": {
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

createOpportunityAndLead

Type: CreateOpportunityAndLead

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an opportunity and lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOpportunityAndLeadInput!)

Input fields for creating an opportunity.

Return fields

Name Description

dateOfCreation (DateTime)

The date the opportunity was created.

funnelCode (String)

The code of the funnel.

opportunityNumber (String)

The unique number of the opportunity.

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.

stage (String)

The stage of the opportunity.

Mutation

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

Variables

{
  "input": CreateOpportunityAndLeadInput
}

Response

{
  "data": {
    "createOpportunityAndLead": {
      "dateOfCreation": "1988-09-12T18:49:31.218593+00:00",
      "funnelCode": "court-amount-hand-play-mention",
      "opportunityNumber": "approach-level-kid-six-where",
      "stage": "character-message-they-property-fill"
    }
  }
}

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

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.

result (String)

Whether the operation was successful.

Mutation

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

Variables

{
  "input": CreateOpportunityFileAttachmentInput
}

Response

{
  "data": {
    "createOpportunityFileAttachment": {
      "result": "finally-themselves-scene-just-outside"
    }
  }
}

createOpportunityForLead

Type: CreateOpportunityForLead

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an opportunity for a lead with the provided details.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOpportunityForLeadInput!)

Input fields for creating an opportunity for a lead.

Return fields

Name Description

dateOfCreation (DateTime)

The date the opportunity was created.

opportunityNumber (String)

The unique number of the opportunity.

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.

Mutation

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

Variables

{
  "input": CreateOpportunityForLeadInput
}

Response

{
  "data": {
    "createOpportunityForLead": {
      "dateOfCreation": "2003-04-10T19:23:21.884423+00:00",
      "opportunityNumber": "art-contain-myself-event-wonder"
    }
  }
}

createOrUpdateLoyaltyCard

Type: CreateOrUpdateLoyaltyCardMutation

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOrUpdateLoyaltyCardInput!)

Input fields for creating or updating a loyalty card.

Return fields

Name Description

loyaltyCard (LoyaltyCardType)

Created or updated loyalty card.

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.

Mutation

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

Variables

{
  "input": CreateOrUpdateLoyaltyCardInput
}

Response

{
  "data": {
    "createOrUpdateLoyaltyCard": {
      "loyaltyCard": LoyaltyCardType
    }
  }
}

createOrUpdateTimeSeriesEntries

Type: CreateOrUpdateTimeSeriesEntries!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create or update time series entries.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateOrUpdateTimeSeriesEntriesInput!)

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

Return fields

Name Description

code (String!)

The time series code.

description (String)

The time series description.

meta (JSONString)

The time series meta information.

name (String!)

The time series display name.

periodSize (String!)

The time series period size value.

productCode (String)

The product code associated to the time series.

unit (String!)

The time series unit value.

variants ([VariantProfile!]!)

The existing time series variants based on the prices created.

Mutation

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

Variables

{
  "input": CreateOrUpdateTimeSeriesEntriesInput
}

Response

{
  "data": {
    "createOrUpdateTimeSeriesEntries": {
      "code": "suffer-third-ok-yard-heart",
      "description": "hospital-receive-continue-direction-market",
      "meta": {"key": "value"},
      "name": "film-nation-produce-example-fact",
      "periodSize": "live-under-officer-southern-window",
      "productCode": "simple-side-movement-how-couple",
      "unit": "interview-ahead-whole-doctor-school",
      "variants": VariantProfile
    }
  }
}

createPaymentActionIntent

Type: CreatePaymentActionIntent

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a new payment action intent.

The possible errors that can be raised are:

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

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 (ID!)

The action intent token.

Mutation

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

Variables

{
  "input": CreatePaymentActionIntentInput
}

Response

{
  "data": {
    "createPaymentActionIntent": {
      "token": "65015518"
    }
  }
}

createPortfolio

Type: CreatePortfolio

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to create a new Portfolio instance.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePortfolioInput)

Input fields for creating a portfolio.

Return fields

Name Description

portfolio (PortfolioType)

The created portfolio.

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.

Mutation

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

Variables

{
  "input": CreatePortfolioInput
}

Response

{
  "data": {
    "createPortfolio": {
      "portfolio": PortfolioType
    }
  }
}

createPortfolioUserRole

Type: CreatePortfolioUserRole

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (CreatePortfolioUserRoleInput)

Input fields for connecting a user to a portfolio.

Return fields

Name Description

portfolioUserRole (PortfolioUserRoleType)

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

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.

Mutation

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

Variables

{
  "input": CreatePortfolioUserRoleInput
}

Response

{
  "data": {
    "createPortfolioUserRole": {
      "portfolioUserRole": PortfolioUserRoleType
    }
  }
}

createPostEvents

Type: CreatePostEvents

URL: https://api.oeg-kraken.energy/v1/graphql/

Create post delivery events from external vendors.

The possible errors that can be raised are:

Arguments

Name Description

input (CreatePostEventsInput!)

Batch of post events to create.

Return fields

Name Description

createdEventsCount (Int)

Number of events successfully created.

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.

Mutation

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

Variables

{
  "input": CreatePostEventsInput
}

Response

{
  "data": {
    "createPostEvents": {
      "createdEventsCount": 74
    }
  }
}

createProduct

Type: CreateProductOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a new product.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateProductInput!)

Return fields

Name Description

product (SupplyProductType)

The created product.

Mutation

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

Variables

{
  "input": CreateProductInput
}

Response

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

createQuote

Type: CreateQuoteOutput

URL: https://api.oeg-kraken.energy/v1/graphql/

Create electricity and gas quotes based on the input parameters.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateQuoteInputParams!)

Return fields

Name Description

affiliateSessionId (ID)

The session id of the affiliate.

code (UUID!)

Code of the quote request that was generated.

electricitySupplyPoint (QuotedSupplyPointType)

Details about the quoted electricity supply point.

gasSupplyPoint (QuotedSupplyPointType)

Details about the quoted gas supply point.

requestedAt (DateTime!)

The date and time when this quote was requested.

Mutation

mutation CreateQuote($input: CreateQuoteInputParams!) {
  createQuote(input: $input) {
    affiliateSessionId
    code
    electricitySupplyPoint {
      ...QuotedSupplyPointTypeFragment
    }
    gasSupplyPoint {
      ...QuotedSupplyPointTypeFragment
    }
    requestedAt
  }
}

Variables

{
  "input": CreateQuoteInputParams
}

Response

{
  "data": {
    "createQuote": {
      "affiliateSessionId": "72524332",
      "code": "67a4c89d-9948-4e43-a3a8-8e6107c61d05",
      "electricitySupplyPoint": QuotedSupplyPointType,
      "gasSupplyPoint": QuotedSupplyPointType,
      "requestedAt": "2002-03-16T19:32:40.416831+00:00"
    }
  }
}

createQuoteForAccount

Type: CreateQuoteForAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a quote for switching product.

The possible errors that can be raised are:

Arguments

Name Description

input (CreateQuoteForAccountInput!)

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.

quoteRequest (MarketSupplyQuoteRequestType)

Returns a quote request.

Mutation

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

Variables

{
  "input": CreateQuoteForAccountInput
}

Response

{
  "data": {
    "createQuoteForAccount": {
      "quoteRequest": MarketSupplyQuoteRequestType
    }
  }
}

createReferral

Type: CreateReferral

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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.

referredAccountRewardAmount (Int)

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

Mutation

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

Variables

{
  "input": CreateReferralInput
}

Response

{
  "data": {
    "createReferral": {
      "referredAccountRewardAmount": 76
    }
  }
}

createReminder

Type: CreateReminder

URL: https://api.oeg-kraken.energy/v1/graphql/

Create an account reminder.

The possible errors that can be raised are:

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

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.

reminder (Reminder)

Account reminder.

Mutation

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

Variables

{
  "input": CreateReminderInput
}

Response

{
  "data": {
    "createReminder": {
      "reminder": Reminder
    }
  }
}

createScheduledTransactions

Type: CreateScheduledTransactions

URL: https://api.oeg-kraken.energy/v1/graphql/

Create scheduled transactions.

The possible errors that can be raised are:

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

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.

scheduledTransactions ([ScheduledTransactionType])

Mutation

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

Variables

{
  "input": CreateScheduledTransactionsInput
}

Response

{
  "data": {
    "createScheduledTransactions": {
      "scheduledTransactions": [ScheduledTransactionType]
    }
  }
}

Arguments

Name Description

input (CreateShellAccountInput!)

Return fields

Name Description

account (AccountInterface)

billingAddressLine1 (String)

billingAddressLine2 (String)

billingAddressLine3 (String)

billingAddressLine4 (String)

billingAddressLine5 (String)

billingName (String)

billingPeriodDay (Int)

Day to fixed bill on if billing_period_length set.

billingPeriodLength (String)

For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY.

billingPeriodMonth (Int)

Month to start billing from if billing_period_length set to QUARTERLY or the multiplier is > 1.

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.

billingPostcode (String)

billingRichAddress (String)

This must be a string-ified version of the JSON representation of RichAddressInput type.

brand (String)

businessType (String)

clientMutationId (String)

companyName (String)

companyNumber (String)

dateOfBirth (Date)

email (String!)

errors ([ErrorType])

familyName (String!)

givenName (String!)

isBusinessAccount (Boolean)

landline (String)

mobile (String)

password (String)

passwordUpdateToken (String)

portfolioNumber (String)

urn (String)

Mutation

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

Variables

{
  "input": CreateShellAccountInput
}

Response

{
  "data": {
    "createShellAccount": {
      "account": AccountInterface,
      "billingAddressLine1": "medical-six-fill-fight-conference",
      "billingAddressLine2": "break-plant-system-instead-fall",
      "billingAddressLine3": "side-consider-idea-remember-study",
      "billingAddressLine4": "son-ground-arm-the-candidate",
      "billingAddressLine5": "action-be-go-image-huge",
      "billingName": "bag-want-reason-drive-over",
      "billingPeriodDay": 67,
      "billingPeriodLength": "main-as-ball-trip-teach",
      "billingPeriodMonth": 90,
      "billingPeriodMultiplier": 78,
      "billingPostcode": "physical-create-than-return-personal",
      "billingRichAddress": "effort-peace-later-executive-agency",
      "brand": "population-administration-kid-none-physical",
      "businessType": "teacher-father-suddenly-plan-attorney",
      "clientMutationId": "19040746",
      "companyName": "mind-south-class-understand-fear",
      "companyNumber": "side-sure-environmental-huge-not",
      "dateOfBirth": "1985-04-19",
      "email": "election-moment-manager-commercial-film",
      "errors": [ErrorType],
      "familyName": "Moss",
      "givenName": "Alyssa",
      "isBusinessAccount": true,
      "landline": "kid-rate-attention-before-feel",
      "mobile": "perform-hard-laugh-beat-up",
      "password": "force-avoid-family-leg-explain",
      "passwordUpdateToken": "answer-source-concern-late-training",
      "portfolioNumber": "P-7020EE27",
      "urn": "through-cut-item-dinner-or"
    }
  }
}

createTimeSeriesPrices

Type: CreateTimeSeriesPrices!

URL: https://api.oeg-kraken.energy/v1/graphql/

Create time series prices.

The possible errors that can be raised are:

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

code (String!)

The time series code.

description (String)

The time series description.

meta (JSONString)

The time series meta information.

name (String!)

The time series display name.

periodSize (String!)

The time series period size value.

productCode (String)

The product code associated to the time series.

unit (String!)

The time series unit value.

variants ([VariantProfile!]!)

The existing time series variants based on the prices created.

Mutation

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

Variables

{
  "input": CreateTimeSeriesPricesInput
}

Response

{
  "data": {
    "createTimeSeriesPrices": {
      "code": "many-price-every-treat-seven",
      "description": "operation-contain-manager-after-task",
      "meta": {"key": "value"},
      "name": "manager-officer-you-peace-beyond",
      "periodSize": "film-quality-despite-line-these",
      "productCode": "value-daughter-class-never-should",
      "unit": "seven-quickly-possible-money-team",
      "variants": VariantProfile
    }
  }
}

deauthenticateDevice

Type: DeauthenticateDevice

URL: https://api.oeg-kraken.energy/v1/graphql/

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

krakenflexDevice (DeviceDetailsType)

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.

Mutation

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

Variables

{
  "input": DeAuthenticationInput
}

Response

{
  "data": {
    "deauthenticateDevice": {
      "krakenflexDevice": DeviceDetailsType
    }
  }
}

deauthenticateFlexDevice

Type: DeauthenticateFlexDevice

URL: https://api.oeg-kraken.energy/v1/graphql/

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

krakenflexDevice (DeviceDetailsType)

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.

Mutation

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

Variables

{
  "input": DeauthenticateFlexDeviceInput
}

Response

{
  "data": {
    "deauthenticateFlexDevice": {
      "krakenflexDevice": DeviceDetailsType
    }
  }
}

deductLoyaltyPoints

Type: DeductLoyaltyPoints

URL: https://api.oeg-kraken.energy/v1/graphql/

Deduct the passed number of Loyalty Points from the account.

The possible errors that can be raised are:

Arguments

Name Description

input (DeductLoyaltyPointsInput!)

Input fields for deducting Loyalty Points.

Return fields

Name Description

ledgerEntry (LoyaltyPointLedgerEntryType)

The ledger entry for the deducted loyalty points.

pointsDeducted (Int)

The number of loyalty points that were deducted.

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.

Mutation

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

Variables

{
  "input": DeductLoyaltyPointsInput
}

Response

{
  "data": {
    "deductLoyaltyPoints": {
      "ledgerEntry": LoyaltyPointLedgerEntryType,
      "pointsDeducted": 98
    }
  }
}

deleteAccountReference

Type: DeleteAccountReference

URL: https://api.oeg-kraken.energy/v1/graphql/

Delete an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteAccountReferenceInput!)

Input fields for removing an account reference.

Return fields

Name Description

accountReference (DeleteAccountReferenceType)

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.

Mutation

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

Variables

{
  "input": DeleteAccountReferenceInput
}

Response

{
  "data": {
    "deleteAccountReference": {
      "accountReference": DeleteAccountReferenceType
    }
  }
}

deleteBoostCharge

Type: DeleteBoostCharge

URL: https://api.oeg-kraken.energy/v1/graphql/

Stop any active boost charging.

The possible errors that can be raised are:

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

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

Variables

{
  "input": DeleteBoostChargeInput
}

Response

{
  "data": {
    "deleteBoostCharge": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

deleteMfaDevice

Type: DeleteMfaDevice

URL: https://api.oeg-kraken.energy/v1/graphql/

Delete MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

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

Return fields

Name Description

deviceDeleted (Boolean)

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

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.

Mutation

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

Variables

{
  "input": DeleteMfaDeviceInputType
}

Response

{
  "data": {
    "deleteMfaDevice": {
      "deviceDeleted": true
    }
  }
}

deletePropertyDescendants

Type: DeletePropertyDescendants

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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.

property (PropertyType)

The property whose descendants were deleted.

Mutation

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

Variables

{
  "input": DeletePropertyDescendantsInput
}

Response

{
  "data": {
    "deletePropertyDescendants": {
      "property": PropertyType
    }
  }
}

deletePushNotificationBinding

Type: DeletePushNotificationBinding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

status (DeletePushNotificationBindingOutput)

Mutation

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

Variables

{
  "input": DeletePushNotificationBindingInput
}

Response

{
  "data": {
    "deletePushNotificationBinding": {
      "status": "SUCCESSFUL"
    }
  }
}

detachSupplyPointFromEstimationGroup

Type: DetachSupplyPointFromEstimationGroup

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

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

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.

supplyPoint (DeletedSupplyPointEstimationGroupType)

The deleted supply point.

Mutation

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

Variables

{
  "input": DetachSupplyPointFromEstimationGroupInput
}

Response

{
  "data": {
    "detachSupplyPointFromEstimationGroup": {
      "supplyPoint": DeletedSupplyPointEstimationGroupType
    }
  }
}

deviceRegistration

Type: DeviceRegistration

URL: https://api.oeg-kraken.energy/v1/graphql/

Register a device (EV, battery or heat pump) for smart control.

The possible errors that can be raised are:

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

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.

registeredDeviceIds ([String])

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

Mutation

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

Variables

{
  "input": DeviceRegistrationInput
}

Response

{
  "data": {
    "deviceRegistration": {
      "registeredDeviceIds": ["game-tend-too-the-price"]
    }
  }
}

endContributionAgreement

Type: EndContributionAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

End a contribution agreement for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (EndContributionAgreementInput!)

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

Return fields

Name Description

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

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.

Mutation

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

Variables

{
  "input": EndContributionAgreementInput
}

Response

{
  "data": {
    "endContributionAgreement": {
      "contributionAgreement": ContributionAgreementType
    }
  }
}

enqueueInboundCall

Type: EnqueueInboundCall

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (EnqueueInboundCallInput!)

Return fields

Name Description

call (InboundCallType)

The call that was enqueued.

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.

Mutation

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

Variables

{
  "input": EnqueueInboundCallInput
}

Response

{
  "data": {
    "enqueueInboundCall": {
      "call": InboundCallType
    }
  }
}

enrollAccountInLoyaltyProgram

Type: EnrollAccountInLoyaltyProgram

URL: https://api.oeg-kraken.energy/v1/graphql/

Enroll users account in Loyalty program.

The possible errors that can be raised are:

Arguments

Name Description

input (EnrollAccountInLoyaltyProgramInput!)

The account number to enroll in the loyalty program.

Return fields

Name Description

outcome (EnrollAccountInLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

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.

Mutation

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

Variables

{
  "input": EnrollAccountInLoyaltyProgramInput
}

Response

{
  "data": {
    "enrollAccountInLoyaltyProgram": {
      "outcome": EnrollAccountInLoyaltyProgramOutcome
    }
  }
}

enrollFanClubAccount

Type: EnrollFanClubAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

Enroll account up to Fan Club.

The possible errors that can be raised are:

Arguments

Name Description

input (JoinFanClubInput!)

Input fields for joining the Fan Club.

Return fields

Name Description

enrollmentOutput (EnrollFanClubAccountOutputType)

Result of the Fan Club enrollment.

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.

Mutation

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

Variables

{
  "input": JoinFanClubInput
}

Response

{
  "data": {
    "enrollFanClubAccount": {
      "enrollmentOutput": EnrollFanClubAccountOutputType
    }
  }
}

enrollment

Type: EnrollmentInitiated!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (EnrollmentInput!)

The Enrollment Input data for the Join Supplier.

Return fields

Name Description

enrollmentProcesses ([EnrollmentProcess]!)

The Enrollment processes that were initiated.

message (String!)

The message to display to the user on Enrollment initiation.

Mutation

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

Variables

{
  "input": EnrollmentInput
}

Response

{
  "data": {
    "enrollment": {
      "enrollmentProcesses": JoinSupplierProcessType,
      "message": "husband-lead-pass-watch-few"
    }
  }
}

fanClubDiscountNotification

Type: FanClubDiscountNotification

URL: https://api.oeg-kraken.energy/v1/graphql/

Send notification of likely Fan Club discount.

The possible errors that can be raised are:

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

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.

success (Boolean!)

Boolean indicating if Fan Club notifications were triggered.

Mutation

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

Variables

{
  "input": FanClubDiscountNotificationInput
}

Response

{
  "data": {
    "fanClubDiscountNotification": {
      "success": true
    }
  }
}

fanClubNonOctopusCustomerComms

Type: FanClubNonOctopusCustomerComms

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

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

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.

success (Boolean!)

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

Mutation

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

Variables

{
  "input": FanClubNonOctopusCustomerCommsInput
}

Response

{
  "data": {
    "fanClubNonOctopusCustomerComms": {
      "success": true
    }
  }
}

fetchGeneratePaymentFingerprint

Type: FetchGeneratePaymentFingerprint

URL: https://api.oeg-kraken.energy/v1/graphql/

Fetch or generate payment fingerprint from vendor.

The possible errors that can be raised are:

Arguments

Name Description

input (FetchGeneratePaymentFingerprintInput!)

Return fields

Name Description

fingerprint (String)

Fetched or generated fingerprint from vendor.

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.

vendor (String)

Vendor name.

Mutation

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

Variables

{
  "input": FetchGeneratePaymentFingerprintInput
}

Response

{
  "data": {
    "fetchGeneratePaymentFingerprint": {
      "fingerprint": "image-every-represent-majority-for",
      "vendor": "approach-people-child-final-doctor"
    }
  }
}

fetchPreSignedLinkForOpportunityAttachment

Type: FetchPreSignedLinkForOpportunityAttachment

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (FetchPreSignedLinkForOpportunityAttachmentInput!)

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

Return fields

Name Description

opportunityFileAttachment (OpportunityFileAttachment)

The opportunity file attachment with pre-signed URL.

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.

Mutation

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

Variables

{
  "input": FetchPreSignedLinkForOpportunityAttachmentInput
}

Response

{
  "data": {
    "fetchPreSignedLinkForOpportunityAttachment": {
      "opportunityFileAttachment": OpportunityFileAttachment
    }
  }
}

forceReauthentication

Type: ForceReauthentication

URL: https://api.oeg-kraken.energy/v1/graphql/

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

effectiveAt (DateTime!)

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

tokensInvalidated (Boolean!)

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

Mutation

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

Variables

{
  "input": ForceReauthenticationInput
}

Response

{
  "data": {
    "forceReauthentication": {
      "effectiveAt": "1990-01-27T22:17:32.353617+00:00",
      "tokensInvalidated": true
    }
  }
}

Arguments

Name Description

input (GenerateAffiliatesAudioRecordingPreSignedUrlInput!)

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

Return fields

Name Description

affiliatesAudioRecordingPreSignedUrl (AffiliateAudioRecordingPresignedPostType)

Input fields required to generate a presigned S3 post for affiliates audio recording.

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.

Mutation

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

Variables

{
  "input": GenerateAffiliatesAudioRecordingPreSignedUrlInput
}

Response

{
  "data": {
    "generateAffiliatesAudioRecordingPreSignedUrl": {
      "affiliatesAudioRecordingPreSignedUrl": AffiliateAudioRecordingPresignedPostType
    }
  }
}

generateInkPresignedUrl

Type: GenerateInkPresignedUrl

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (GenerateInkPresignedUrlInput)

Return fields

Name Description

fields (JSONString!)

Presigned post fields required to upload the file.

key (String!)

The key for the item.

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.

Mutation

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

Variables

{
  "input": GenerateInkPresignedUrlInput
}

Response

{
  "data": {
    "generateInkPresignedUrl": {
      "fields": {"key": "value"},
      "key": "color-forward-relate-PM-here",
      "uploadUrl": "include-treat-either-speak-play"
    }
  }
}

generateLeadsFileAttachmentDownloadPreSignedUrl

Type: GenerateLeadsFileAttachmentDownloadPreSignedUrl

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

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

leadsFileAttachmentDownloadPreSignedUrl (LeadsFileAttachmentDownloadPresignedUrlType)

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

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.

Mutation

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

Variables

{
  "input": GenerateLeadsFileAttachmentDownloadPreSignedUrlInput
}

Response

{
  "data": {
    "generateLeadsFileAttachmentDownloadPreSignedUrl": {
      "leadsFileAttachmentDownloadPreSignedUrl": LeadsFileAttachmentDownloadPresignedUrlType
    }
  }
}

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

leadsFileAttachmentPreSignedUrl (LeadsFileAttachmentPresignedPostType)

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

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.

Mutation

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

Variables

{
  "input": GenerateLeadsFileAttachmentPreSignedUrlInput
}

Response

{
  "data": {
    "generateLeadsFileAttachmentPreSignedUrl": {
      "leadsFileAttachmentPreSignedUrl": LeadsFileAttachmentPresignedPostType
    }
  }
}

generatePreSignedToken

Type: GeneratePreSignedToken

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

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.

scope (PreSignedTokenScope)

token (String)

tokenExpiryDatetime (DateTime)

Mutation

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

Variables

{
  "email": "agree-free-man-may-job",
  "numberOfDaysAllowed": 57,
  "scope": "SUBMIT_METER_READINGS"
}

Response

{
  "data": {
    "generatePreSignedToken": {
      "scope": "SUBMIT_METER_READINGS",
      "token": "see-energy-skill-arm-its",
      "tokenExpiryDatetime": "1988-09-07T07:28:14.918797+00:00"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type: GetEmbeddedSecretForNewPaymentInstruction

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

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

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.

secretKey (String)

Mutation

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "secretKey": "agreement-red-brother-man-power"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type: GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

secretKey (String)

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

Mutation

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

Variables

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

Response

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "secretKey": "what-speech-ball-over-others"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type: GetHostedUrlForNewPaymentInstruction

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

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

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.

url (String)

URL at which payment instruction can be set up.

Mutation

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

Variables

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

Response

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "url": "southern-word-really-hour-paper"
    }
  }
}

getOrCreateAgreement

Type: GetOrCreateAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (CreateAgreementInput!)

Input fields for getting or creating an agreement.

Return fields

Name Description

agreement (CommonAgreementType)

The agreement that was retrieved or created.

created (Boolean)

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

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.

Mutation

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

Variables

{
  "input": CreateAgreementInput
}

Response

{
  "data": {
    "getOrCreateAgreement": {
      "agreement": CommonAgreementType,
      "created": true
    }
  }
}

grantUserAccessToBusiness

Type: GrantUserAccessToBusiness

URL: https://api.oeg-kraken.energy/v1/graphql/

Grant user access to the business using the provided role.

The possible errors that can be raised are:

Arguments

Name Description

input (GrantUserAccessToBusinessInput!)

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.

Mutation

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

Variables

{
  "input": GrantUserAccessToBusinessInput
}

Response

{
  "data": {
    "grantUserAccessToBusiness": {

    }
  }
}

initializeAccount

Type: InitializeAccountResult!

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (BaseInitializeAccountInput!)

Return fields

Name Description

accountNumber (String)

The account number of the newly created account or the existing account to be re-used.

isNewAccount (Boolean)

Was a new account created.

Mutation

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

Variables

{
  "input": BaseInitializeAccountInput
}

Response

{
  "data": {
    "initializeAccount": {
      "accountNumber": "A-3F1FD06C",
      "isNewAccount": true
    }
  }
}

initializeUser

Type: InitializeUserResult!

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (BaseInitializeUserInput!)

Return fields

Name Description

isNewUser (Boolean)

Was a new user created.

userNumber (String)

The user number of the newly created user or the existing user to be re-used.

Mutation

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

Variables

{
  "input": BaseInitializeUserInput
}

Response

{
  "data": {
    "initializeUser": {
      "isNewUser": true,
      "userNumber": "sign-sport-able-realize-his"
    }
  }
}

initiateHostedStandalonePayment

Type: InitiateHostedStandalonePayment

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

payment (InitiateHostedStandalonePaymentOutput)

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

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.

Mutation

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

Variables

{
  "input": InitiateHostedStandalonePaymentInput
}

Response

{
  "data": {
    "initiateHostedStandalonePayment": {
      "payment": InitiateHostedStandalonePaymentOutput
    }
  }
}

initiateProductSwitch

Type: InitiateProductSwitch

URL: https://api.oeg-kraken.energy/v1/graphql/

Do a product switch for a user.

The possible errors that can be raised are:

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

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.

productCode (String!)

The selected product for a specific product switch.

switchDate (Date!)

The date at which the product switch becomes effective.

Mutation

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

Variables

{
  "input": InitiateProductSwitchInput
}

Response

{
  "data": {
    "initiateProductSwitch": {
      "productCode": "wide-seem-some-attack-development",
      "switchDate": "1976-01-12"
    }
  }
}

initiateStandalonePayment

Type: InitiateStandalonePayment

URL: https://api.oeg-kraken.energy/v1/graphql/

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

The possible errors that can be raised are:

Arguments

Name Description

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

payment (InitiateStandalonePaymentOutput)

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.

Mutation

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

Variables

{
  "input": InitiateStandalonePaymentInput
}

Response

{
  "data": {
    "initiateStandalonePayment": {
      "payment": InitiateStandalonePaymentOutput
    }
  }
}

instigateContractTermination

Type: ContractTerminationInstigated!

URL: https://api.oeg-kraken.energy/v1/graphql/

Instigate a contract termination journey.

The possible errors that can be raised are:

Arguments

Name Description

input (BaseInstigateContractTerminationInput!)

Return fields

Name Description

message (String!)

The message to display to the user on termination instigation.

Mutation

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

Variables

{
  "input": BaseInstigateContractTerminationInput
}

Response

{
  "data": {
    "instigateContractTermination": {
      "message": "kitchen-person-lead-clearly-environment"
    }
  }
}

instigateContractVariation

Type: InstigateContractVariationOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Instigate a contract variation journey.

The possible errors that can be raised are:

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

contract (Contract)

The contract with the varied terms.

Mutation

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

Variables

{
  "input": InstigateContractVariationInput
}

Response

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

instigateLeaveSupplier

Type: LeaveSupplierInstigated!

URL: https://api.oeg-kraken.energy/v1/graphql/

Instigate a leave supplier process or update an existing process.

The possible errors that can be raised are:

Arguments

Name Description

input (LeaveSupplierInput!)

Return fields

Name Description

leaveSupplierProcessId (ID)

The ID of the newly created or existing leave supplier process.

Deprecated

The 'leaveSupplierProcessId' field is deprecated.

Process IDs are deprecated, please use 'number' instead.

- Marked as deprecated on 2025-08-06.
- Scheduled for removal on or after 2025-09-30.

message (String!)

The message to display to the user on termination initiation.

number (ID!)

The number of the newly created or existing leave supplier process.

Mutation

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

Variables

{
  "input": LeaveSupplierInput
}

Response

{
  "data": {
    "instigateLeaveSupplier": {
      "message": "again-how-record-call-including",
      "number": "69469644"
    }
  }
}

invalidatePaymentInstruction

Type: InvalidatePaymentInstruction

URL: https://api.oeg-kraken.energy/v1/graphql/

Invalidate an existing instruction.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePaymentInstructionInput!)

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

Return fields

Name Description

instruction (InvalidatePaymentInstructionOutput)

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.

Mutation

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

Variables

{
  "input": InvalidatePaymentInstructionInput
}

Response

{
  "data": {
    "invalidatePaymentInstruction": {
      "instruction": InvalidatePaymentInstructionOutput
    }
  }
}

invalidatePreSignedToken

Type: InvalidatePreSignedToken

URL: https://api.oeg-kraken.energy/v1/graphql/

Invalidate a previously-issued pre-signed token.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePreSignedTokenInput!)

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 (PreSignedToken)

Mutation

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

Variables

{
  "input": InvalidatePreSignedTokenInput
}

Response

{
  "data": {
    "invalidatePreSignedToken": {
      "token": PreSignedToken
    }
  }
}

invalidatePreSignedTokensForUser

Type: InvalidatePreSignedTokensForUser

URL: https://api.oeg-kraken.energy/v1/graphql/

Invalidate pre-signed tokens issued to a particular user.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidatePreSignedTokensForUserInput!)

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.

tokens ([PreSignedToken])

Mutation

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

Variables

{
  "input": InvalidatePreSignedTokensForUserInput
}

Response

{
  "data": {
    "invalidatePreSignedTokensForUser": {
      "tokens": [PreSignedToken]
    }
  }
}

invalidateRefreshToken

Type: InvalidateRefreshToken

URL: https://api.oeg-kraken.energy/v1/graphql/

Invalidate a previously-issued refresh token.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidateRefreshTokenInput!)

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 (RefreshToken)

Mutation

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

Variables

{
  "input": InvalidateRefreshTokenInput
}

Response

{
  "data": {
    "invalidateRefreshToken": {
      "token": RefreshToken
    }
  }
}

invalidateRefreshTokensForUser

Type: InvalidateRefreshTokensForUser

URL: https://api.oeg-kraken.energy/v1/graphql/

Invalidate refresh tokens issued to a particular user.

The possible errors that can be raised are:

Arguments

Name Description

input (InvalidateRefreshTokensForUserInput!)

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.

tokens ([RefreshToken])

Mutation

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

Variables

{
  "input": InvalidateRefreshTokensForUserInput
}

Response

{
  "data": {
    "invalidateRefreshTokensForUser": {
      "tokens": [RefreshToken]
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type: JoinSupplierAcceptTermsAndConditions

URL: https://api.oeg-kraken.energy/v1/graphql/

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

Arguments

Name Description

input (JoinSupplierAcceptTermsAndConditionsInput!)

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.

success (Boolean)

Indicator that the mutation has completed successfully.

Mutation

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

Variables

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

Response

{
  "data": {
    "joinSupplierAcceptTermsAndConditions": {
      "success": true
    }
  }
}

legacyProcessOrder

Type: ProcessOrderOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Process an Order (legacy)

The possible errors that can be raised are:

Arguments

Name Description

input (LegacyProcessOrderInput!)

Return fields

Name Description

identifier (NonEmptyString)

The unique identifier of the processed order.

resources ([OrderResource!])

The resources associated with the processed order.

status (OrderStatus)

The status of the order processing.

Mutation

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

Variables

{
  "input": LegacyProcessOrderInput
}

Response

{
  "data": {
    "legacyProcessOrder": {
      "identifier": "45798601",
      "resources": [OrderResource],
      "status": "PENDING"
    }
  }
}

linkAccountToBusiness

Type: LinkAccountToBusiness

URL: https://api.oeg-kraken.energy/v1/graphql/

Link an account to a business.

The possible errors that can be raised are:

Arguments

Name Description

input (LinkAccountToBusinessInput!)

Input fields for linking an account to a business.

Return fields

Name Description

business (BusinessType)

The business the account was linked to.

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.

Mutation

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

Variables

{
  "input": LinkAccountToBusinessInput
}

Response

{
  "data": {
    "linkAccountToBusiness": {
      "business": BusinessType
    }
  }
}

linkUserToLine

Type: LinkUserToLineResponse!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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

Variables

{
  "input": LinkUserToLineInput
}

Response

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

markPrintBatchAsProcessed

Type: MarkPrintBatchAsProcessed!

URL: https://api.oeg-kraken.energy/v1/graphql/

Mark the print batch as processed.

The possible errors that can be raised are:

Arguments

Name Description

printBatchId (ID!)

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.

printBatch (PrintBatchType)

Mutation

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

Variables

{
  "printBatchId": "10307610"
}

Response

{
  "data": {
    "markPrintBatchAsProcessed": {
      "printBatch": PrintBatchType
    }
  }
}

masqueradeAuthentication

Type: MasqueradeAuthentication

URL: https://api.oeg-kraken.energy/v1/graphql/

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

errors ([ErrorType])

A list of any errors that occurred while running this mutation.

token (String)

A Kraken Token that can be used to authenticate to the API, masquerading as the desired user.

Mutation

mutation MasqueradeAuthentication(
  $masqueradeToken: String!,
  $userId: String!
) {
  masqueradeAuthentication(
    masqueradeToken: $masqueradeToken,
    userId: $userId
  ) {
    errors {
      ...ErrorTypeFragment
    }
    token
  }
}

Variables

{
  "masqueradeToken": "perform-have-public-form-magazine",
  "userId": "94035039"
}

Response

{
  "data": {
    "masqueradeAuthentication": {
      "errors": [ErrorType],
      "token": "campaign-already-it-summer-method"
    }
  }
}

moveOut

Type: MoveOut

URL: https://api.oeg-kraken.energy/v1/graphql/

Cancel contract due to move out from the customer and send a confirmation email.

Arguments

Name Description

input (CancelContractInput!)

Input variables needed for cancelling the contract.

Return fields

Name Description

cancelledContract (Boolean)

Whether the contract cancellation was successful.

lastDayOfSupply (Date)

The last day of supply.

Mutation

mutation MoveOut($input: CancelContractInput!) {
  moveOut(input: $input) {
    cancelledContract
    lastDayOfSupply
  }
}

Variables

{
  "input": CancelContractInput
}

Response

{
  "data": {
    "moveOut": {
      "cancelledContract": true,
      "lastDayOfSupply": "1973-03-17"
    }
  }
}

moveToBucket

Type: MoveToBucket

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (MoveToBucketInput)

Input for moving a conversation to a bucket.

Return fields

Name Description

conversation (InkConversation!)

The conversation that was moved to the bucket.

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.

Mutation

mutation MoveToBucket($input: MoveToBucketInput) {
  moveToBucket(input: $input) {
    conversation {
      ...InkConversationFragment
    }
  }
}

Variables

{
  "input": MoveToBucketInput
}

Response

{
  "data": {
    "moveToBucket": {
      "conversation": InkConversation
    }
  }
}

Arguments

Name Description

teamGroupName (String!)

The name of the operations team group to select from.

Return fields

Name Description

allInferredRoutingAttributes ([String]!)

All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONS_GROUP.TEAM.Team_A', 'OPERATIONS_GROUP.LOCATION.London', 'OPERATIONS_GROUP.GROUP_B']). Recommended for IVR usage.

location (TeamLocation!)

Location routing information for the selected team.

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.

teamGroups ([TeamGroup]!)

All operations team groups that the selected team belongs to.

Mutation

mutation NextOperationsTeamRoundRobin($teamGroupName: String!) {
  nextOperationsTeamRoundRobin(teamGroupName: $teamGroupName) {
    allInferredRoutingAttributes
    location {
      ...TeamLocationFragment
    }
    team {
      ...TeamFragment
    }
    teamGroups {
      ...TeamGroupFragment
    }
  }
}

Variables

{
  "teamGroupName": "effect-out-occur-appear-material"
}

Response

{
  "data": {
    "nextOperationsTeamRoundRobin": {
      "allInferredRoutingAttributes": "seek-husband-yourself-up-civil",
      "location": TeamLocation,
      "team": Team,
      "teamGroups": TeamGroup
    }
  }
}

obtainKrakenToken

Type: ObtainKrakenJSONWebToken

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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.

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.

refreshExpiresIn (Int)

A Unix timestamp representing the point in time at which the refresh token will expire.

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.

token (String!)

The Kraken Token. Can be used in the Authorization header for subsequent calls to the API to access protected resources.

Mutation

mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
  obtainKrakenToken(input: $input) {
    payload
    refreshExpiresIn
    refreshToken
    token
  }
}

Variables

{
  "input": ObtainJSONWebTokenInput
}

Response

{
  "data": {
    "obtainKrakenToken": {
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshExpiresIn": 11,
      "refreshToken": "father-prevent-artist-pattern-inside",
      "token": "natural-who-drug-yet-attention"
    }
  }
}

obtainLongLivedRefreshToken

Type: ObtainLongLivedRefreshToken

URL: https://api.oeg-kraken.energy/v1/graphql/

For authorized third-party organizations only.

The possible errors that can be raised are:

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

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.

refreshExpiresIn (Int!)

refreshToken (String)

Mutation

mutation ObtainLongLivedRefreshToken($input: ObtainLongLivedRefreshTokenInput!) {
  obtainLongLivedRefreshToken(input: $input) {
    refreshExpiresIn
    refreshToken
  }
}

Variables

{
  "input": ObtainLongLivedRefreshTokenInput
}

Response

{
  "data": {
    "obtainLongLivedRefreshToken": {
      "refreshExpiresIn": 70,
      "refreshToken": "soon-blue-kitchen-quite-control"
    }
  }
}

ocppAuthentication

Type: OCPPAuthentication

URL: https://api.oeg-kraken.energy/v1/graphql/

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation OcppAuthentication($input: OCPPAuthenticationInput) {
  ocppAuthentication(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": OCPPAuthenticationInput
}

Response

{
  "data": {
    "ocppAuthentication": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

pauseCollectionProcess

Type: PauseCollectionProcess

URL: https://api.oeg-kraken.energy/v1/graphql/

Pause a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (PauseCollectionProcessInput!)

Details for pausing a collection process.

Return fields

Name Description

collectionProcessPaused (PauseCollectionProcessOutput)

Collection process pause output.

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.

Mutation

mutation PauseCollectionProcess($input: PauseCollectionProcessInput!) {
  pauseCollectionProcess(input: $input) {
    collectionProcessPaused {
      ...PauseCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": PauseCollectionProcessInput
}

Response

{
  "data": {
    "pauseCollectionProcess": {
      "collectionProcessPaused": PauseCollectionProcessOutput
    }
  }
}

pauseDunning

Type: PauseDunning

URL: https://api.oeg-kraken.energy/v1/graphql/

Pause the dunning process for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (PauseDunningInputType!)

Input variables needed for pausing a dunning process for an account.

Return fields

Name Description

pauseCreated (Boolean)

Whether the pause has been successfully created.

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.

Mutation

mutation PauseDunning($input: PauseDunningInputType!) {
  pauseDunning(input: $input) {
    pauseCreated
  }
}

Variables

{
  "input": PauseDunningInputType
}

Response

{
  "data": {
    "pauseDunning": {
      "pauseCreated": true
    }
  }
}

payoutReferralForAccount

Type: PayoutReferralForAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

Pay out a referral reward for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (PayoutReferralForAccountInput!)

Input fields for paying out a referral for an account.

Return fields

Name Description

payoutResult (PayoutReferralForAccountResultType)

The result of the payout.

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.

Mutation

mutation PayoutReferralForAccount($input: PayoutReferralForAccountInput!) {
  payoutReferralForAccount(input: $input) {
    payoutResult {
      ...PayoutReferralForAccountResultTypeFragment
    }
  }
}

Variables

{
  "input": PayoutReferralForAccountInput
}

Response

{
  "data": {
    "payoutReferralForAccount": {
      "payoutResult": PayoutReferralForAccountResultType
    }
  }
}

performHouseMove

Type: PerformHouseMove

URL: https://api.oeg-kraken.energy/v1/graphql/

Performs a house move.

The possible errors that can be raised are:

Arguments

Name Description

input (HouseMoveInput!)

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.

Mutation

mutation PerformHouseMove($input: HouseMoveInput!) {
  performHouseMove(input: $input) {
  }
}

Variables

{
  "input": HouseMoveInput
}

Response

{
  "data": {
    "performHouseMove": {

    }
  }
}

postCredit

Type: PostCredit

URL: https://api.oeg-kraken.energy/v1/graphql/

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

credit (Credit)

Posted account credit.

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.

Mutation

mutation PostCredit($input: PostCreditInput!) {
  postCredit(input: $input) {
    credit {
      ...CreditFragment
    }
  }
}

Variables

{
  "input": PostCreditInput
}

Response

{
  "data": {
    "postCredit": {
      "credit": Credit
    }
  }
}

prepareAccount

Type: PrepareAccountResult!

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (PrepareAccountInput!)

Return fields

Name Description

accountNumber (String)

The account number of the newly created account or the existing account to be re-used.

isNewAccount (Boolean)

Was a new account created.

isNewUser (Boolean)

Was a new user created.

userId (ID)

The ID of the newly created or existing account user.

userNumber (String)

The user number of the newly created or existing account user.

Mutation

mutation PrepareAccount($input: PrepareAccountInput!) {
  prepareAccount(input: $input) {
    accountNumber
    isNewAccount
    isNewUser
    userId
    userNumber
  }
}

Variables

{
  "input": PrepareAccountInput
}

Response

{
  "data": {
    "prepareAccount": {
      "accountNumber": "A-B33127AD",
      "isNewAccount": true,
      "isNewUser": true,
      "userId": "99306045",
      "userNumber": "easy-task-minute-increase-different"
    }
  }
}

productSwitch

Type: ProductSwitch

URL: https://api.oeg-kraken.energy/v1/graphql/

Confirm a product switch.

The possible errors that can be raised are:

Arguments

Name Description

input (ProductSwitchInput!)

Input variables needed to confirm a product switch.

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.

productSwitched (Boolean)

Whether the product switch was successful.

Mutation

mutation ProductSwitch($input: ProductSwitchInput!) {
  productSwitch(input: $input) {
    productSwitched
  }
}

Variables

{
  "input": ProductSwitchInput
}

Response

{
  "data": {
    "productSwitch": {
      "productSwitched": true
    }
  }
}

publishTransactionalMessagingExternalTrigger

Type: PublishTransactionalMessagingExternalTrigger

URL: https://api.oeg-kraken.energy/v1/graphql/

Publish an externally defined transactional messaging trigger.

The possible errors that can be raised are:

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

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.

trigger (Trigger)

The trigger that has been published.

Mutation

mutation PublishTransactionalMessagingExternalTrigger($input: PublishTransactionalMessagingExternalTriggerInput!) {
  publishTransactionalMessagingExternalTrigger(input: $input) {
    trigger {
      ...TriggerFragment
    }
  }
}

Variables

{
  "input": PublishTransactionalMessagingExternalTriggerInput
}

Response

{
  "data": {
    "publishTransactionalMessagingExternalTrigger": {
      "trigger": Trigger
    }
  }
}

publishTransactionalMessagingTrigger

Type: PublishTransactionalMessagingTrigger

URL: https://api.oeg-kraken.energy/v1/graphql/

Publish a trigger within the transactional messaging service.

The possible errors that can be raised are:

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

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.

trigger (Trigger)

The trigger that has been published.

Mutation

mutation PublishTransactionalMessagingTrigger($input: PublishTransactionalMessagingTriggerInput!) {
  publishTransactionalMessagingTrigger(input: $input) {
    trigger {
      ...TriggerFragment
    }
  }
}

Variables

{
  "input": PublishTransactionalMessagingTriggerInput
}

Response

{
  "data": {
    "publishTransactionalMessagingTrigger": {
      "trigger": Trigger
    }
  }
}

Arguments

Name Description

input (PurchaseVoucherInput!)

Return fields

Name Description

voucherPurchase (VoucherPurchaseType)

The voucher purchase created from the mutation.

Mutation

mutation PurchaseVoucher($input: PurchaseVoucherInput!) {
  purchaseVoucher(input: $input) {
    voucherPurchase {
      ...VoucherPurchaseTypeFragment
    }
  }
}

Variables

{
  "input": PurchaseVoucherInput
}

Response

{
  "data": {
    "purchaseVoucher": {
      "voucherPurchase": VoucherPurchaseType
    }
  }
}

reactivateCollectionProcessRecord

Type: ReactivateCollectionProcessRecord

URL: https://api.oeg-kraken.energy/v1/graphql/

Reactivate a Collection Process Record that was previously activated.

The possible errors that can be raised are:

Arguments

Name Description

input (ReactivateCollectionProcessRecordInputType!)

Input variables needed for reactivating a collection process record.

Return fields

Name Description

collectionProcessReactivated (ReactivateCollectionProcessRecordOutputType)

The reactivated collection process record.

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.

Mutation

mutation ReactivateCollectionProcessRecord($input: ReactivateCollectionProcessRecordInputType!) {
  reactivateCollectionProcessRecord(input: $input) {
    collectionProcessReactivated {
      ...ReactivateCollectionProcessRecordOutputTypeFragment
    }
  }
}

Variables

{
  "input": ReactivateCollectionProcessRecordInputType
}

Response

{
  "data": {
    "reactivateCollectionProcessRecord": {
      "collectionProcessReactivated": ReactivateCollectionProcessRecordOutputType
    }
  }
}

recordDepositAgreementAccepted

Type: RecordDepositAgreementAccepted

URL: https://api.oeg-kraken.energy/v1/graphql/

Record the customer's acceptance of a deposit agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (DepositAgreementInput!)

Return fields

Name Description

isRecorded (Boolean)

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.

Mutation

mutation RecordDepositAgreementAccepted($input: DepositAgreementInput!) {
  recordDepositAgreementAccepted(input: $input) {
    isRecorded
  }
}

Variables

{
  "input": DepositAgreementInput
}

Response

{
  "data": {
    "recordDepositAgreementAccepted": {
      "isRecorded": true
    }
  }
}

recordPendingPayment

Type: RecordPendingPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Record one or more pending payments.

The possible errors that can be raised are:

Arguments

Name Description

input (RecordPendingPaymentInput!)

Details about the pending payments.

Return fields

Name Description

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

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.

Mutation

mutation RecordPendingPayment($input: RecordPendingPaymentInput!) {
  recordPendingPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordPendingPaymentInput
}

Response

{
  "data": {
    "recordPendingPayment": {
      "noticeBatchIdentifier": "15155714"
    }
  }
}

recordSuccessfulPayment

Type: RecordSuccessfulPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Record one or more successful payments.

The possible errors that can be raised are:

Arguments

Name Description

input (RecordSuccessfulPaymentInput!)

Details about the successful payments.

Return fields

Name Description

noticeBatchIdentifier (String!)

The unique identifier of the notice batch created from the input.

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.

Mutation

mutation RecordSuccessfulPayment($input: RecordSuccessfulPaymentInput!) {
  recordSuccessfulPayment(input: $input) {
    noticeBatchIdentifier
  }
}

Variables

{
  "input": RecordSuccessfulPaymentInput
}

Response

{
  "data": {
    "recordSuccessfulPayment": {
      "noticeBatchIdentifier": "46142776"
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type: RedeemLoyaltyPointsForAccountCredit

URL: https://api.oeg-kraken.energy/v1/graphql/

Redeem the passed number of Loyalty Points as account credit.

The possible errors that can be raised are:

Arguments

Name Description

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

Name Description

pointsRedeemed (Int)

The number of loyalty points that were redeemed.

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.

Mutation

mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
  redeemLoyaltyPointsForAccountCredit(input: $input) {
    pointsRedeemed
  }
}

Variables

{
  "input": RedeemLoyaltyPointsInput
}

Response

{
  "data": {
    "redeemLoyaltyPointsForAccountCredit": {
      "pointsRedeemed": 10
    }
  }
}

redeemReferralClaimCode

Type: RedeemReferralClaimCode

URL: https://api.oeg-kraken.energy/v1/graphql/

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

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

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.

success (Boolean!)

Whether or not the request was successful.

Mutation

mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
  redeemReferralClaimCode(input: $input) {
    success
  }
}

Variables

{
  "input": RedeemReferralClaimCodeInput
}

Response

{
  "data": {
    "redeemReferralClaimCode": {
      "success": true
    }
  }
}

refundPayment

Type: RefundPayment

URL: https://api.oeg-kraken.energy/v1/graphql/

Refund a cleared payment.

The possible errors that can be raised are:

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

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.

repayment (AccountRepaymentType)

The repayment for the requested refund.

Mutation

mutation RefundPayment($input: RefundPaymentInput!) {
  refundPayment(input: $input) {
    repayment {
      ...AccountRepaymentTypeFragment
    }
  }
}

Variables

{
  "input": RefundPaymentInput
}

Response

{
  "data": {
    "refundPayment": {
      "repayment": AccountRepaymentType
    }
  }
}

regenerateSecretKey

Type: RegenerateSecretKey

URL: https://api.oeg-kraken.energy/v1/graphql/

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

mutation RegenerateSecretKey {
  regenerateSecretKey {
    key
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Response

{
  "data": {
    "regenerateSecretKey": {
      "key": "heavy-paper-raise-industry-free",
      "viewer": AccountUserType
    }
  }
}

registerLeadFlowStatusEvent

Type: RegisterLeadFlowStatusEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Register a flow status event for a lead.

The possible errors that can be raised are:

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

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.

Mutation

mutation RegisterLeadFlowStatusEvent($input: RegisterLeadFlowStatusEventInput!) {
  registerLeadFlowStatusEvent(input: $input) {
  }
}

Variables

{
  "input": RegisterLeadFlowStatusEventInput
}

Response

{
  "data": {
    "registerLeadFlowStatusEvent": {

    }
  }
}

registerOpportunityFlowStatusEvent

Type: RegisterOpportunityFlowStatusEvent

URL: https://api.oeg-kraken.energy/v1/graphql/

Register a flow status event for an opportunity.

The possible errors that can be raised are:

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

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.

Mutation

mutation RegisterOpportunityFlowStatusEvent($input: RegisterOpportunityFlowStatusEventInput!) {
  registerOpportunityFlowStatusEvent(input: $input) {
  }
}

Variables

{
  "input": RegisterOpportunityFlowStatusEventInput
}

Response

{
  "data": {
    "registerOpportunityFlowStatusEvent": {

    }
  }
}

registerPushNotificationBinding

Type: RegisterPushNotificationBinding

URL: https://api.oeg-kraken.energy/v1/graphql/

Register a device token to be used for push notifications for an app.

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

mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
  registerPushNotificationBinding(input: $input) {
    pushNotificationBinding {
      ...PushNotificationBindingTypeFragment
    }
  }
}

Variables

{
  "input": RegisterPushNotificationBindingInput
}

Response

{
  "data": {
    "registerPushNotificationBinding": {
      "pushNotificationBinding": PushNotificationBindingType
    }
  }
}

removeCampaignFromAccount

Type: RemoveCampaignFromAccount

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (RemoveCampaignFromAccountInput!)

Input variables needed for removing a campaign from an account.

Return fields

Name Description

campaignRemoved (Boolean)

Whether the campaign was successfully removed from the account.

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.

Mutation

mutation RemoveCampaignFromAccount($input: RemoveCampaignFromAccountInput!) {
  removeCampaignFromAccount(input: $input) {
    campaignRemoved
  }
}

Variables

{
  "input": RemoveCampaignFromAccountInput
}

Response

{
  "data": {
    "removeCampaignFromAccount": {
      "campaignRemoved": true
    }
  }
}

removeCampaignItems

Type: RemoveCampaignItems

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (RemoveCampaignItemsInput!)

Return fields

Name Description

campaignItems ([VoiceCampaignItemType])

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.

Mutation

mutation RemoveCampaignItems($input: RemoveCampaignItemsInput!) {
  removeCampaignItems(input: $input) {
    campaignItems {
      ...VoiceCampaignItemTypeFragment
    }
  }
}

Variables

{
  "input": RemoveCampaignItemsInput
}

Response

{
  "data": {
    "removeCampaignItems": {
      "campaignItems": [VoiceCampaignItemType]
    }
  }
}

removeItemsFromRiskList

Type: RemoveItemsFromRiskList

URL: https://api.oeg-kraken.energy/v1/graphql/

Remove items from the risk list.

The possible errors that can be raised are:

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

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.

riskIdentifiers ([RiskListItemType])

List of successfully removed risk identifiers.

Mutation

mutation RemoveItemsFromRiskList($input: [RiskListItemInputType]!) {
  removeItemsFromRiskList(input: $input) {
    riskIdentifiers {
      ...RiskListItemTypeFragment
    }
  }
}

Variables

{
  "input": RiskListItemInputType
}

Response

{
  "data": {
    "removeItemsFromRiskList": {
      "riskIdentifiers": [RiskListItemType]
    }
  }
}

removePropertyFromHierarchy

Type: RemovePropertyFromHierarchy

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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.

property (PropertyType)

The property that was removed from the hierarchy.

Mutation

mutation RemovePropertyFromHierarchy($input: RemovePropertyFromHierarchyInput!) {
  removePropertyFromHierarchy(input: $input) {
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "input": RemovePropertyFromHierarchyInput
}

Response

{
  "data": {
    "removePropertyFromHierarchy": {
      "property": PropertyType
    }
  }
}

requestDoubleOptIn

Type: RequestDoubleOptIn

URL: https://api.oeg-kraken.energy/v1/graphql/

Request a double opt in

The possible errors that can be raised are:

Arguments

Name Description

input (DoubleOptInInput)

Return fields

Name Description

consent (ConsentType)

The consent that was created or updated.

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.

Mutation

mutation RequestDoubleOptIn($input: DoubleOptInInput) {
  requestDoubleOptIn(input: $input) {
    consent {
      ...ConsentTypeFragment
    }
  }
}

Variables

{
  "input": DoubleOptInInput
}

Response

{
  "data": {
    "requestDoubleOptIn": {
      "consent": ConsentType
    }
  }
}

requestPasswordReset

Type: RequestPasswordResetOutputType

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
  requestPasswordReset(input: $input) {
    email
    userNumber
  }
}

Variables

{
  "input": RequestPasswordResetInput
}

Response

{
  "data": {
    "requestPasswordReset": {
      "email": "hold-technology-trial-lot-assume",
      "userNumber": "claim-various-environment-avoid-bad"
    }
  }
}

requestPrintedBill

Type: RequestPrintedBill

URL: https://api.oeg-kraken.energy/v1/graphql/

Request an issued bill to be printed and (re)posted to billing address of the account.

The possible errors that can be raised are:

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

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.

success (Boolean)

Whether the request was successful.

Mutation

mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
  requestPrintedBill(input: $input) {
    success
  }
}

Variables

{
  "input": RequestPrintedBillInput
}

Response

{
  "data": {
    "requestPrintedBill": {
      "success": true
    }
  }
}

resetPassword

Type: ResetPasswordMutationPayload

URL: https://api.oeg-kraken.energy/v1/graphql/

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

clientMutationId (String)

errors ([SerializerFieldErrorsType])

Mutation

mutation ResetPassword($input: ResetPasswordMutationInput!) {
  resetPassword(input: $input) {
    clientMutationId
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
  }
}

Variables

{
  "input": ResetPasswordMutationInput
}

Response

{
  "data": {
    "resetPassword": {
      "clientMutationId": "50324011",
      "errors": [SerializerFieldErrorsType]
    }
  }
}

resetUserPassword

Type: ResetUserPasswordOutput

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

Name Description

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.

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.

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.

userId (ID!)

The ID of the user whose password was changed.

Mutation

mutation ResetUserPassword($input: ResetUserPasswordInput!) {
  resetUserPassword(input: $input) {
    userId
  }
}

Variables

{
  "input": ResetUserPasswordInput
}

Response

{
  "data": {
    "resetUserPassword": {
      "userId": "33924564"
    }
  }
}

resumeCollectionProcess

Type: ResumeCollectionProcess

URL: https://api.oeg-kraken.energy/v1/graphql/

Resume a collection process.

The possible errors that can be raised are:

Arguments

Name Description

input (ResumeCollectionProcessInput!)

Details for resuming a collection process.

Return fields

Name Description

collectionProcessResumed (ResumeCollectionProcessOutput)

Collection process resume output.

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.

Mutation

mutation ResumeCollectionProcess($input: ResumeCollectionProcessInput!) {
  resumeCollectionProcess(input: $input) {
    collectionProcessResumed {
      ...ResumeCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": ResumeCollectionProcessInput
}

Response

{
  "data": {
    "resumeCollectionProcess": {
      "collectionProcessResumed": ResumeCollectionProcessOutput
    }
  }
}

resumeControl

Type: ResumeDeviceControl

URL: https://api.oeg-kraken.energy/v1/graphql/

Resume control of the device.

The possible errors that can be raised are:

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation ResumeControl($input: AccountNumberInput) {
  resumeControl(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "resumeControl": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

revokeAgreement

Type: RevokeAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

Revoke an agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeAgreementInput!)

Input fields for revoking an agreement.

Return fields

Name Description

account (AccountType)

Account responsible for the revoked agreement.

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.

Mutation

mutation RevokeAgreement($input: RevokeAgreementInput!) {
  revokeAgreement(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": RevokeAgreementInput
}

Response

{
  "data": {
    "revokeAgreement": {
      "account": AccountType
    }
  }
}

revokeContract

Type: RevokeContractOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Revoke an existing contract.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeContractInput!)

Return fields

Name Description

contract (Contract)

The contract revoked.

Mutation

mutation RevokeContract($input: RevokeContractInput!) {
  revokeContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": RevokeContractInput
}

Response

{
  "data": {
    "revokeContract": {
      "contract": Contract
    }
  }
}

revokeSupplyContract

Type: RevokeSupplyContract

URL: https://api.oeg-kraken.energy/v1/graphql/

Revoke contract. Currently allowed up to 14 days after contract confirmation.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeSupplyContractInput!)

Input variables needed for revoking the contract.

Return fields

Name Description

contractRevoked (Boolean!)

Whether the contract revocation was successful.

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.

Mutation

mutation RevokeSupplyContract($input: RevokeSupplyContractInput!) {
  revokeSupplyContract(input: $input) {
    contractRevoked
  }
}

Variables

{
  "input": RevokeSupplyContractInput
}

Response

{
  "data": {
    "revokeSupplyContract": {
      "contractRevoked": true
    }
  }
}

revokeUserAccessFromBusiness

Type: RevokeUserAccessFromBusiness

URL: https://api.oeg-kraken.energy/v1/graphql/

Revoke the selected role from the user for the business.

The possible errors that can be raised are:

Arguments

Name Description

input (RevokeUserAccessFromBusinessInput!)

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.

Mutation

mutation RevokeUserAccessFromBusiness($input: RevokeUserAccessFromBusinessInput!) {
  revokeUserAccessFromBusiness(input: $input) {
  }
}

Variables

{
  "input": RevokeUserAccessFromBusinessInput
}

Response

{
  "data": {
    "revokeUserAccessFromBusiness": {

    }
  }
}

runAgreementRollover

Type: RunAgreementRollover

URL: https://api.oeg-kraken.energy/v1/graphql/

Run an agreement rollover.

The possible errors that can be raised are:

Arguments

Name Description

input (RunAgreementRolloverInput!)

Input for running an agreement rollover.

Return fields

Name Description

agreementRollover (AgreementRolloverType)

The executed agreement rollover.

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.

Mutation

mutation RunAgreementRollover($input: RunAgreementRolloverInput!) {
  runAgreementRollover(input: $input) {
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

Variables

{
  "input": RunAgreementRolloverInput
}

Response

{
  "data": {
    "runAgreementRollover": {
      "agreementRollover": AgreementRolloverType
    }
  }
}

scheduleQuoteFollowUp

Type: ScheduleQuoteFollowUp

URL: https://api.oeg-kraken.energy/v1/graphql/

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

Arguments

Name Description

input (QuoteShareInput!)

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.

success (Boolean!)

Whether the message was scheduled successfully.

Mutation

mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
  scheduleQuoteFollowUp(input: $input) {
    success
  }
}

Variables

{
  "input": QuoteShareInput
}

Response

{
  "data": {
    "scheduleQuoteFollowUp": {
      "success": true
    }
  }
}

selectChargePointMakeForSmartFlexOnboarding

Type: SelectChargePointMakeForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectChargePointMakeForSmartFlexOnboarding($input: SelectChargePointMakeInput!) {
  selectChargePointMakeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectChargePointMakeInput
}

Response

{
  "data": {
    "selectChargePointMakeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectChargePointVariantForSmartFlexOnboarding

Type: SelectChargePointVariantForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectChargePointVariantForSmartFlexOnboarding($input: SelectChargePointVariantInput!) {
  selectChargePointVariantForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectChargePointVariantInput
}

Response

{
  "data": {
    "selectChargePointVariantForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectDeviceTypeForSmartFlexOnboarding

Type: SelectDeviceTypeForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectDeviceTypeForSmartFlexOnboarding($input: SelectDeviceTypeInput!) {
  selectDeviceTypeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectDeviceTypeInput
}

Response

{
  "data": {
    "selectDeviceTypeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectFromListForSmartFlexOnboarding

Type: SelectFromListForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectFromListForSmartFlexOnboarding($input: SelectFromListInput!) {
  selectFromListForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectFromListInput
}

Response

{
  "data": {
    "selectFromListForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectInverterMakeForSmartFlexOnboarding

Type: SelectInverterMakeForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectInverterMakeForSmartFlexOnboarding($input: SelectInverterMakeInput!) {
  selectInverterMakeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectInverterMakeInput
}

Response

{
  "data": {
    "selectInverterMakeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectProducts

Type: SelectProducts

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

success (Boolean!)

Whether we successfully marked the chosen quoted products as selected.

Mutation

mutation SelectProducts($input: SelectProductsInput!) {
  selectProducts(input: $input) {
    success
  }
}

Variables

{
  "input": SelectProductsInput
}

Response

{
  "data": {
    "selectProducts": {
      "success": true
    }
  }
}

selectUserVehicleForSmartFlexOnboarding

Type: SelectUserVehicleForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectUserVehicleForSmartFlexOnboarding($input: SelectUserVehicleInput!) {
  selectUserVehicleForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectUserVehicleInput
}

Response

{
  "data": {
    "selectUserVehicleForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleMakeForSmartFlexOnboarding

Type: SelectVehicleMakeForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectVehicleMakeForSmartFlexOnboarding($input: SelectVehicleMakeInput!) {
  selectVehicleMakeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectVehicleMakeInput
}

Response

{
  "data": {
    "selectVehicleMakeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleOrChargePointForSmartFlexOnboarding

Type: CompleteSelectVehicleOrChargePointForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectVehicleOrChargePointForSmartFlexOnboarding($input: SelectVehicleOrChargePointInput!) {
  selectVehicleOrChargePointForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectVehicleOrChargePointInput
}

Response

{
  "data": {
    "selectVehicleOrChargePointForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectVehicleVariantForSmartFlexOnboarding

Type: SelectVehicleVariantForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectVehicleVariantForSmartFlexOnboarding($input: SelectVehicleVariantInput!) {
  selectVehicleVariantForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectVehicleVariantInput
}

Response

{
  "data": {
    "selectVehicleVariantForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

sendOfferQuoteSummary

Type: SendOfferQuoteSummary

URL: https://api.oeg-kraken.energy/v1/graphql/

Send an offer quote summary to all active account users.

The possible errors that can be raised are:

Arguments

Name Description

input (OfferQuoteSummaryInput!)

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.

success (Boolean!)

Whether the triggering of the offer quote summary was successful.

Mutation

mutation SendOfferQuoteSummary($input: OfferQuoteSummaryInput!) {
  sendOfferQuoteSummary(input: $input) {
    success
  }
}

Variables

{
  "input": OfferQuoteSummaryInput
}

Response

{
  "data": {
    "sendOfferQuoteSummary": {
      "success": true
    }
  }
}

sendQuoteSummary

Type: SendQuoteSummary

URL: https://api.oeg-kraken.energy/v1/graphql/

Send a quote summary to the provided recipient.

The possible errors that can be raised are:

Arguments

Name Description

input (QuoteShareInput!)

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.

success (Boolean!)

Whether the triggering of the quote summary was successful.

Mutation

mutation SendQuoteSummary($input: QuoteShareInput!) {
  sendQuoteSummary(input: $input) {
    success
  }
}

Variables

{
  "input": QuoteShareInput
}

Response

{
  "data": {
    "sendQuoteSummary": {
      "success": true
    }
  }
}

sendVerificationEmail

Type: SendVerificationEmail

URL: https://api.oeg-kraken.energy/v1/graphql/

Verify user's email address.

The possible errors that can be raised are:

Arguments

Name Description

input (SendVerificationEmailInput!)

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.

verificationStatus (Boolean)

If the verification email was sent.

Mutation

mutation SendVerificationEmail($input: SendVerificationEmailInput!) {
  sendVerificationEmail(input: $input) {
    verificationStatus
  }
}

Variables

{
  "input": SendVerificationEmailInput
}

Response

{
  "data": {
    "sendVerificationEmail": {
      "verificationStatus": true
    }
  }
}

setDevicePreferences

Type: SmartFlexDeviceInterface

URL: https://api.oeg-kraken.energy/v1/graphql/

Set the user preferences for a device.

The possible errors that can be raised are:

Arguments

Name Description

input (SmartFlexDevicePreferencesInput!)

The device preference details to be updated.

Return fields

Name Description

alerts ([SmartFlexDeviceAlertInterface])

Active alert message(s) for a device, showing the latest first.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

id (ID!)

A UUID that identifies this device registration. Re-registering this device will result in a different ID.

integrationDeviceId (String)

The third-party integration device ID.

name (String)

The user-friendly name for the device.

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

propertyId (String)

The id of the property linked to the device.

provider (ProviderChoices!)

The third-party that enables control of this device.

reAuthenticationState (DeviceReAuthenticationInterface)

The re-authentication state of this device, if applicable.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

Mutation

mutation SetDevicePreferences($input: SmartFlexDevicePreferencesInput!) {
  setDevicePreferences(input: $input) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "input": SmartFlexDevicePreferencesInput
}

Response

{
  "data": {
    "setDevicePreferences": {
      "alerts": SmartFlexDeviceAlertInterface,
      "deviceType": "BATTERIES",
      "id": "47011379",
      "integrationDeviceId": "12280108",
      "name": "interesting-summer-water-sport-anyone",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "preferences": SmartFlexDevicePreferencesInterface,
      "propertyId": "71643339",
      "provider": "BYD",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}

setLoyaltyPointsUser

Type: SetLoyaltyPointsUser

URL: https://api.oeg-kraken.energy/v1/graphql/

Set the Loyalty Point user for the account.

The possible errors that can be raised are:

Arguments

Name Description

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

Name Description

newLoyaltyPointsUserId (String)

ID of the new Loyalty Points user.

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.

Mutation

mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
  setLoyaltyPointsUser(input: $input) {
    newLoyaltyPointsUserId
  }
}

Variables

{
  "input": SetLoyaltyPointsUserInput
}

Response

{
  "data": {
    "setLoyaltyPointsUser": {
      "newLoyaltyPointsUserId": "49349461"
    }
  }
}

setOpportunityOutcome

Type: SetOpportunityOutcome

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the opportunity outcome to mark the opportunity as won or lost.

The possible errors that can be raised are:

Arguments

Name Description

input (SetOpportunityOutcomeInput!)

Input fields for setting the outcome of a opportunity.

Return fields

Name Description

message (String)

Success message for now.

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.

Mutation

mutation SetOpportunityOutcome($input: SetOpportunityOutcomeInput!) {
  setOpportunityOutcome(input: $input) {
    message
  }
}

Variables

{
  "input": SetOpportunityOutcomeInput
}

Response

{
  "data": {
    "setOpportunityOutcome": {
      "message": "message-for-father-bill-coach"
    }
  }
}

setPaymentPreference

Type: SetPaymentPreference

URL: https://api.oeg-kraken.energy/v1/graphql/

Set a preference to collect payments from a specific payment method.

The possible errors that can be raised are:

Arguments

Name Description

input (SetPaymentPreferenceInput!)

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.

Mutation

mutation SetPaymentPreference($input: SetPaymentPreferenceInput!) {
  setPaymentPreference(input: $input) {
  }
}

Variables

{
  "input": SetPaymentPreferenceInput
}

Response

{
  "data": {
    "setPaymentPreference": {

    }
  }
}

setUpDirectDebitInstruction

Type: SetUpDirectDebitInstruction

URL: https://api.oeg-kraken.energy/v1/graphql/

Set up a new direct debit instruction.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

paymentInstruction (DirectDebitInstructionType)

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.

Mutation

mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
  setUpDirectDebitInstruction(input: $input) {
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": SetUpDirectDebitInstructionInput
}

Response

{
  "data": {
    "setUpDirectDebitInstruction": {
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setUpDirectDebitInstructionForBusiness

Type: SetUpDirectDebitInstructionForBusiness

URL: https://api.oeg-kraken.energy/v1/graphql/

Set up a new direct debit instruction for a business.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionForBusinessInput!)

Input fields for creating a new direct debit instruction.

Return fields

Name Description

paymentInstruction (DirectDebitInstructionType)

The created direct debit instruction.

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.

Mutation

mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
  setUpDirectDebitInstructionForBusiness(input: $input) {
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": SetUpDirectDebitInstructionForBusinessInput
}

Response

{
  "data": {
    "setUpDirectDebitInstructionForBusiness": {
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setUpDirectDebitInstructionFromStoredDetails

Type: SetUpDirectDebitInstructionFromStoredDetails

URL: https://api.oeg-kraken.energy/v1/graphql/

Set up a new direct debit instruction from stored details.

The possible errors that can be raised are:

Arguments

Name Description

input (SetUpDirectDebitInstructionFromStoredDetailsInput!)

Input fields for creating a new direct debit instruction from stored details.

Return fields

Name Description

paymentInstruction (DirectDebitInstructionType)

The payment instruction that was created from stored details.

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.

Mutation

mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
  setUpDirectDebitInstructionFromStoredDetails(input: $input) {
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

Variables

{
  "input": SetUpDirectDebitInstructionFromStoredDetailsInput
}

Response

{
  "data": {
    "setUpDirectDebitInstructionFromStoredDetails": {
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

setVehicleChargePreferences

Type: SetVehicleChargingPreferences

URL: https://api.oeg-kraken.energy/v1/graphql/

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation SetVehicleChargePreferences($input: VehicleChargingPreferencesInput) {
  setVehicleChargePreferences(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": VehicleChargingPreferencesInput
}

Response

{
  "data": {
    "setVehicleChargePreferences": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

shareGoodsQuote

Type: ShareGoodsQuote

URL: https://api.oeg-kraken.energy/v1/graphql/

Share a goods quote.

The possible errors that can be raised are:

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

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.

share (GoodsQuoteShare)

Goods quote shared.

Mutation

mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
  shareGoodsQuote(input: $input) {
    share {
      ...GoodsQuoteShareFragment
    }
  }
}

Variables

{
  "input": ShareGoodsQuoteInput
}

Response

{
  "data": {
    "shareGoodsQuote": {
      "share": GoodsQuoteShare
    }
  }
}

specialCancelContract

Type: SpecialCancelContract

URL: https://api.oeg-kraken.energy/v1/graphql/

Trigger special cancellation for a contract.

The possible errors that can be raised are:

Arguments

Name Description

input (SpecialCancelContractInput!)

Input variables needed for specially cancelling the contract.

Return fields

Name Description

cancelledContract (Boolean)

Whether the special contract cancellation was successful.

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.

Mutation

mutation SpecialCancelContract($input: SpecialCancelContractInput!) {
  specialCancelContract(input: $input) {
    cancelledContract
  }
}

Variables

{
  "input": SpecialCancelContractInput
}

Response

{
  "data": {
    "specialCancelContract": {
      "cancelledContract": true
    }
  }
}

startCollectionProcess

Type: StartCollectionProcess

URL: https://api.oeg-kraken.energy/v1/graphql/

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

collectionProcessStarted (StartCollectionProcessOutput)

Details of collection process that has been started.

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.

Mutation

mutation StartCollectionProcess($input: StartCollectionProcessInput!) {
  startCollectionProcess(input: $input) {
    collectionProcessStarted {
      ...StartCollectionProcessOutputFragment
    }
  }
}

Variables

{
  "input": StartCollectionProcessInput
}

Response

{
  "data": {
    "startCollectionProcess": {
      "collectionProcessStarted": StartCollectionProcessOutput
    }
  }
}

startCustomerVerification

Type: StartCustomerVerification

URL: https://api.oeg-kraken.energy/v1/graphql/

Start the customer verification using the provided verification method.

The possible errors that can be raised are:

Arguments

Name Description

input (StartCustomerVerificationInput!)

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.

verificationProcess (VerificationProcess)

The newly created verification process.

Mutation

mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
  startCustomerVerification(input: $input) {
    verificationProcess {
      ...VerificationProcessFragment
    }
  }
}

Variables

{
  "input": StartCustomerVerificationInput
}

Response

{
  "data": {
    "startCustomerVerification": {
      "verificationProcess": VerificationProcess
    }
  }
}

startOnSiteJobsAppointmentBookingSession

Type: StartOnSiteJobsAppointmentBookingSession

URL: https://api.oeg-kraken.energy/v1/graphql/

Start the appointment booking process for an on-site jobs request.

The possible errors that can be raised are:

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

appointmentBookingSessionId (UUID)

The Kraken booking ID for the appointment booking session.

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.

Mutation

mutation StartOnSiteJobsAppointmentBookingSession(
  $appointmentBookingDetails: OnSiteJobsAppointmentBookingDetailsInput!,
  $appointmentIdToReschedule: UUID,
  $overrideAppointmentCheckWarnings: Boolean,
  $requestId: UUID!
) {
  startOnSiteJobsAppointmentBookingSession(
    appointmentBookingDetails: $appointmentBookingDetails,
    appointmentIdToReschedule: $appointmentIdToReschedule,
    overrideAppointmentCheckWarnings: $overrideAppointmentCheckWarnings,
    requestId: $requestId
  ) {
    appointmentBookingSessionId
  }
}

Variables

{
  "appointmentBookingDetails": OnSiteJobsAppointmentBookingDetailsInput,
  "appointmentIdToReschedule": "72f70b4a-2597-4351-bb19-0ee6411f3777",
  "overrideAppointmentCheckWarnings": true,
  "requestId": "dff5f60c-393c-4e97-a90f-533d8c2fbb4d"
}

Response

{
  "data": {
    "startOnSiteJobsAppointmentBookingSession": {
      "appointmentBookingSessionId": "dc5dc138-58be-4240-823e-a9b5bea8a5bd"
    }
  }
}

startReAuthentication

Type: StartReAuthentication

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a wizard for re-authenticating a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (StartReAuthenticationInput!)

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for re-authenticating the device with SmartFlex.

Mutation

mutation StartReAuthentication($input: StartReAuthenticationInput!) {
  startReAuthentication(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": StartReAuthenticationInput
}

Response

{
  "data": {
    "startReAuthentication": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

startSmartFlexOnboarding

Type: StartSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

Create a wizard for onboarding a device with SmartFlex.

The possible errors that can be raised are:

Arguments

Name Description

input (StartSmartFlexOnboardingInput!)

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation StartSmartFlexOnboarding($input: StartSmartFlexOnboardingInput!) {
  startSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": StartSmartFlexOnboardingInput
}

Response

{
  "data": {
    "startSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

startTestChargeForSmartFlexOnboarding

Type: StartTestChargeForSmartFlexOnboarding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

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.

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation StartTestChargeForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  startTestChargeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

{
  "data": {
    "startTestChargeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

stopAutomatedPayments

Type: StopAutomatedPayments

URL: https://api.oeg-kraken.energy/v1/graphql/

Set a preference to not collect automated payments.

The possible errors that can be raised are:

Arguments

Name Description

input (StopAutomatedPaymentsInput!)

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.

Mutation

mutation StopAutomatedPayments($input: StopAutomatedPaymentsInput!) {
  stopAutomatedPayments(input: $input) {
  }
}

Variables

{
  "input": StopAutomatedPaymentsInput
}

Response

{
  "data": {
    "stopAutomatedPayments": {

    }
  }
}

storeDirectDebitPaymentMethodDetails

Type: StoreDirectDebitPaymentMethodDetails

URL: https://api.oeg-kraken.energy/v1/graphql/

Store bank details with the vendor.

The possible errors that can be raised are:

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

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.

storedPaymentMethodDetailsReference (String)

Mutation

mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
  storeDirectDebitPaymentMethodDetails(input: $input) {
    storedPaymentMethodDetailsReference
  }
}

Variables

{
  "input": StoreDirectDebitPaymentMethodDetailsInput
}

Response

{
  "data": {
    "storeDirectDebitPaymentMethodDetails": {
      "storedPaymentMethodDetailsReference": "difference-event-account-bad-treatment"
    }
  }
}

storePaymentInstruction

Type: StorePaymentInstruction

URL: https://api.oeg-kraken.energy/v1/graphql/

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

Arguments

Name Description

input (StorePaymentInstructionInput!)

Input fields for storing a new payment instruction created through the embedded process.

Return fields

Name Description

paymentInstruction (PaymentInstructionType)

The stored payment instruction.

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.

Mutation

mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
  storePaymentInstruction(input: $input) {
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
  }
}

Variables

{
  "input": StorePaymentInstructionInput
}

Response

{
  "data": {
    "storePaymentInstruction": {
      "paymentInstruction": PaymentInstructionType
    }
  }
}

submitCustomerFeedback

Type: SubmitCustomerFeedback

URL: https://api.oeg-kraken.energy/v1/graphql/

Submit customer feedback.

The possible errors that can be raised are:

Arguments

Name Description

input (CustomerFeedbackInputType!)

Return fields

Name Description

customerFeedback (CustomerFeedbackType)

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.

Mutation

mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
  submitCustomerFeedback(input: $input) {
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

Variables

{
  "input": CustomerFeedbackInputType
}

Response

{
  "data": {
    "submitCustomerFeedback": {
      "customerFeedback": CustomerFeedbackType
    }
  }
}

submitRepaymentRequest

Type: SubmitRepaymentRequest

URL: https://api.oeg-kraken.energy/v1/graphql/

Submit a repayment request.

The possible errors that can be raised are:

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

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.

repaymentRequest (RequestRepaymentOutputType)

The newly created repayment request.

Mutation

mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
  submitRepaymentRequest(input: $input) {
    repaymentRequest {
      ...RequestRepaymentOutputTypeFragment
    }
  }
}

Variables

{
  "input": RequestRepaymentInputType
}

Response

{
  "data": {
    "submitRepaymentRequest": {
      "repaymentRequest": RequestRepaymentOutputType
    }
  }
}

suspendControl

Type: SuspendDeviceControl

URL: https://api.oeg-kraken.energy/v1/graphql/

Suspend control of the device.

The possible errors that can be raised are:

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation SuspendControl($input: AccountNumberInput) {
  suspendControl(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "suspendControl": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

switchAccountToVariablePaymentSchedule

Type: SwitchAccountToVariablePaymentSchedule

URL: https://api.oeg-kraken.energy/v1/graphql/

Switch account to variable payment schedule. Current schedule type will be preserved.

The possible errors that can be raised are:

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

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.

schedule (PaymentScheduleType!)

New payment schedule.

Mutation

mutation SwitchAccountToVariablePaymentSchedule($input: SwitchAccountToVariablePaymentScheduleInput!) {
  switchAccountToVariablePaymentSchedule(input: $input) {
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": SwitchAccountToVariablePaymentScheduleInput
}

Response

{
  "data": {
    "switchAccountToVariablePaymentSchedule": {
      "schedule": PaymentScheduleType
    }
  }
}

terminateAgreement

Type: TerminateAgreement

URL: https://api.oeg-kraken.energy/v1/graphql/

Terminate an agreement.

The possible errors that can be raised are:

Arguments

Name Description

input (TerminateAgreementInput!)

Input for terminating an agreement.

Return fields

Name Description

agreement (CommonAgreementType)

The created agreement.

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.

Mutation

mutation TerminateAgreement($input: TerminateAgreementInput!) {
  terminateAgreement(input: $input) {
    agreement {
      ...CommonAgreementTypeFragment
    }
  }
}

Variables

{
  "input": TerminateAgreementInput
}

Response

{
  "data": {
    "terminateAgreement": {
      "agreement": CommonAgreementType
    }
  }
}

terminateContract

Type: TerminateContractOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Terminate an existing contract.

The possible errors that can be raised are:

Arguments

Name Description

input (TerminateContractInput!)

Return fields

Name Description

contract (Contract)

The contract terminated.

Mutation

mutation TerminateContract($input: TerminateContractInput!) {
  terminateContract(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": TerminateContractInput
}

Response

{
  "data": {
    "terminateContract": {
      "contract": Contract
    }
  }
}

terminateCreditTransferPermission

Type: TerminateCreditTransferPermission

URL: https://api.oeg-kraken.energy/v1/graphql/

Terminate credit transfer permission.

The possible errors that can be raised are:

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

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.

validTo (DateTime)

Datetime when the credit transfer permission ends.

Mutation

mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
  terminateCreditTransferPermission(input: $input) {
    validTo
  }
}

Variables

{
  "input": TerminateCreditTransferPermissionInput
}

Response

{
  "data": {
    "terminateCreditTransferPermission": {
      "validTo": "1973-02-22T16:43:33.127044+00:00"
    }
  }
}

thirdPartyCompleteDeviceRegistration

Type: ThirdPartyCompleteDeviceRegistration

URL: https://api.oeg-kraken.energy/v1/graphql/

Completes the registration of a device if the contract is eligible and the device registration valid.

The possible errors that can be raised are:

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

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.

success (ThirdPartyCompleteDeviceRegistrationType)

The response showing account validity and optional tariff information.

Mutation

mutation ThirdPartyCompleteDeviceRegistration($input: CompleteDeviceRegistrationInput) {
  thirdPartyCompleteDeviceRegistration(input: $input) {
    success {
      ...ThirdPartyCompleteDeviceRegistrationTypeFragment
    }
  }
}

Variables

{
  "input": CompleteDeviceRegistrationInput
}

Response

{
  "data": {
    "thirdPartyCompleteDeviceRegistration": {
      "success": ThirdPartyCompleteDeviceRegistrationType
    }
  }
}

transferLeadOpportunities

Type: TransferLeadOpportunities

URL: https://api.oeg-kraken.energy/v1/graphql/

Transfer opportunities across leads.

The possible errors that can be raised are:

Arguments

Name Description

input (TransferLeadOpportunitiesInput!)

Input for transfer opportunities across leads.

Return fields

Name Description

opportunitiesTransferred (Int)

Number of opportunities transferred.

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.

Mutation

mutation TransferLeadOpportunities($input: TransferLeadOpportunitiesInput!) {
  transferLeadOpportunities(input: $input) {
    opportunitiesTransferred
  }
}

Variables

{
  "input": TransferLeadOpportunitiesInput
}

Response

{
  "data": {
    "transferLeadOpportunities": {
      "opportunitiesTransferred": 3
    }
  }
}

transferLedgerBalance

Type: TransferLedgerBalance

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (TransferLedgerBalanceInputType!)

Input fields for processing an account balance transfer.

Return fields

Name Description

balanceTransfer (AccountBalanceTransferType)

Balance transfer details.

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.

Mutation

mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
  transferLedgerBalance(input: $input) {
    balanceTransfer {
      ...AccountBalanceTransferTypeFragment
    }
  }
}

Variables

{
  "input": TransferLedgerBalanceInputType
}

Response

{
  "data": {
    "transferLedgerBalance": {
      "balanceTransfer": AccountBalanceTransferType
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type: TransferLoyaltyPointsBetweenUsers

URL: https://api.oeg-kraken.energy/v1/graphql/

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

Arguments

Name Description

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

Name Description

pointsTransferred (Int)

The number of loyalty points that were transferred.

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.

Mutation

mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
  transferLoyaltyPointsBetweenUsers(input: $input) {
    pointsTransferred
  }
}

Variables

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

Response

{
  "data": {
    "transferLoyaltyPointsBetweenUsers": {
      "pointsTransferred": 17
    }
  }
}

triggerBoostCharge

Type: PerformBoostCharge

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation TriggerBoostCharge($input: AccountNumberInput) {
  triggerBoostCharge(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "triggerBoostCharge": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

triggerCollectionProcessMessage

Type: TriggerCollectionProcessMessage

URL: https://api.oeg-kraken.energy/v1/graphql/

Trigger a collection process message with safety checks.

The possible errors that can be raised are:

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

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.

triggerResult (TriggerCollectionProcessMessageOutput)

Details of the triggered communication.

Mutation

mutation TriggerCollectionProcessMessage($input: TriggerCollectionProcessMessageInput!) {
  triggerCollectionProcessMessage(input: $input) {
    triggerResult {
      ...TriggerCollectionProcessMessageOutputFragment
    }
  }
}

Variables

{
  "input": TriggerCollectionProcessMessageInput
}

Response

{
  "data": {
    "triggerCollectionProcessMessage": {
      "triggerResult": TriggerCollectionProcessMessageOutput
    }
  }
}

triggerTestCharge

Type: PerformTestCharge

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (AccountNumberInput)

Return fields

Name Description

krakenflexDevice (KrakenFlexDeviceType)

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.

Mutation

mutation TriggerTestCharge($input: AccountNumberInput) {
  triggerTestCharge(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "triggerTestCharge": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

unenrollAccountFromLoyaltyProgram

Type: UnenrollAccountFromLoyaltyProgram

URL: https://api.oeg-kraken.energy/v1/graphql/

Unenroll users account from Loyalty program.

The possible errors that can be raised are:

Arguments

Name Description

input (UnenrollAccountFromLoyaltyProgramInput!)

The account number to unenroll from the loyalty program.

Return fields

Name Description

outcome (UnenrollAccountFromLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

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.

Mutation

mutation UnenrollAccountFromLoyaltyProgram($input: UnenrollAccountFromLoyaltyProgramInput!) {
  unenrollAccountFromLoyaltyProgram(input: $input) {
    outcome {
      ...UnenrollAccountFromLoyaltyProgramOutcomeFragment
    }
  }
}

Variables

{
  "input": UnenrollAccountFromLoyaltyProgramInput
}

Response

{
  "data": {
    "unenrollAccountFromLoyaltyProgram": {
      "outcome": UnenrollAccountFromLoyaltyProgramOutcome
    }
  }
}

Return fields

Name Description

Mutation

mutation UnlinkUserFromLine {
  unlinkUserFromLine {
    ... on LineCommonError {
      ...LineCommonErrorFragment
    }
    ... on LineUnlinkedResponse {
      ...LineUnlinkedResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
  }
}

Response

{
  "data": {
    "unlinkUserFromLine": LineUnlinkedResponse
  }
}

updateAccountBillingAddress

Type: UpdateAccountBillingAddress

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the account billing address.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

Name Description

account (AccountType)

The updated account.

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.

Mutation

mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
  updateAccountBillingAddress(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": AccountBillingAddressInput
}

Response

{
  "data": {
    "updateAccountBillingAddress": {
      "account": AccountType
    }
  }
}

updateAccountBillingEmail

Type: UpdateAccountBillingEmail

URL: https://api.oeg-kraken.energy/v1/graphql/

Update account billing email.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

Name Description

account (AccountInterface)

Account that was changed.

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.

Mutation

mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
  updateAccountBillingEmail(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateAccountBillingEmailInput
}

Response

{
  "data": {
    "updateAccountBillingEmail": {
      "account": AccountInterface
    }
  }
}

updateAccountConsents

Type: UpdateAccountConsents

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the consents of an account

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

Name Description

consents ([ConsentType!]!)

Consents linked to this account.

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.

Mutation

mutation UpdateAccountConsents(
  $accountNumber: String!,
  $consents: [ConsentInput]!
) {
  updateAccountConsents(
    accountNumber: $accountNumber,
    consents: $consents
  ) {
    consents {
      ...ConsentTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "A-58913D5C",
  "consents": ConsentInput
}

Response

{
  "data": {
    "updateAccountConsents": {
      "consents": ConsentType
    }
  }
}

updateAccountReference

Type: UpdateAccountReference

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an account reference.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

Name Description

accountReference (AccountReferenceType)

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.

Mutation

mutation UpdateAccountReference($input: AccountReferenceInput!) {
  updateAccountReference(input: $input) {
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

Variables

{
  "input": AccountReferenceInput
}

Response

{
  "data": {
    "updateAccountReference": {
      "accountReference": AccountReferenceType
    }
  }
}

updateAccountReferralStatus

Type: UpdateAccountReferralStatus

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the status of an account referral.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAccountReferralStatusInput!)

Input fields for updating the status of an account referral.

Return fields

Name Description

accountReferral (ReferralType)

The updated account referral instance.

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.

Mutation

mutation UpdateAccountReferralStatus($input: UpdateAccountReferralStatusInput!) {
  updateAccountReferralStatus(input: $input) {
    accountReferral {
      ...ReferralTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAccountReferralStatusInput
}

Response

{
  "data": {
    "updateAccountReferralStatus": {
      "accountReferral": ReferralType
    }
  }
}

updateAccountUserConsents

Type: UpdateAccountUserConsents

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the consents of an account user (the authenticated user)

The possible errors that can be raised are:

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

accountUserConsents (AccountUserConsents)

All the consents for an account user.

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.

Mutation

mutation UpdateAccountUserConsents(
  $consents: [ConsentTypeInput],
  $userNumber: String
) {
  updateAccountUserConsents(
    consents: $consents,
    userNumber: $userNumber
  ) {
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

Variables

{
  "consents": ConsentTypeInput,
  "userNumber": "throw-billion-nation-teacher-order"
}

Response

{
  "data": {
    "updateAccountUserConsents": {
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateActivePurchase

Type: UpdateActivePurchase

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an active purchase.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

Name Description

goodsPurchase (GoodsPurchase)

Goods purchase updated.

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.

Mutation

mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
  updateActivePurchase(input: $input) {
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

Variables

{
  "input": UpdatePurchaseInput
}

Response

{
  "data": {
    "updateActivePurchase": {
      "goodsPurchase": GoodsPurchase
    }
  }
}

Type: UpdateAffiliateLink!

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an existing affiliate link.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAffiliateLinkInputType!)

Input fields for Updating an existing affiliate link.

Return fields

Name Description

affiliateLink (AffiliateLinkType)

The updated affiliate link.

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.

Mutation

mutation UpdateAffiliateLink($input: UpdateAffiliateLinkInputType!) {
  updateAffiliateLink(input: $input) {
    affiliateLink {
      ...AffiliateLinkTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateLinkInputType
}

Response

{
  "data": {
    "updateAffiliateLink": {
      "affiliateLink": AffiliateLinkType
    }
  }
}

updateAffiliateOrganisation

Type: UpdateAffiliateOrganisation!

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an existing affiliate organisation.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAffiliateOrganisationInputType!)

Input fields for Updating an existing affiliate organisation.

Return fields

Name Description

affiliateOrganisation (AffiliateOrganisationType)

The updated affiliate organisation.

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.

Mutation

mutation UpdateAffiliateOrganisation($input: UpdateAffiliateOrganisationInputType!) {
  updateAffiliateOrganisation(input: $input) {
    affiliateOrganisation {
      ...AffiliateOrganisationTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAffiliateOrganisationInputType
}

Response

{
  "data": {
    "updateAffiliateOrganisation": {
      "affiliateOrganisation": AffiliateOrganisationType
    }
  }
}

updateAgentAuxiliaryStatus

Type: UpdateAgentAuxiliaryStatus

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

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

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.

success (Boolean)

Whether the auxiliary status was successfully updated.

Mutation

mutation UpdateAgentAuxiliaryStatus($input: UpdateAgentAuxiliaryStatusInput!) {
  updateAgentAuxiliaryStatus(input: $input) {
    success
  }
}

Variables

{
  "input": UpdateAgentAuxiliaryStatusInput
}

Response

{
  "data": {
    "updateAgentAuxiliaryStatus": {
      "success": true
    }
  }
}

updateAgreementPeriod

Type: UpdateAgreementPeriod

URL: https://api.oeg-kraken.energy/v1/graphql/

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 valid_to date must be later than valid_from 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

account (AccountType)

Account responsible for the update agreement.

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.

Mutation

mutation UpdateAgreementPeriod($input: UpdateAgreementPeriodInput!) {
  updateAgreementPeriod(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementPeriodInput
}

Response

{
  "data": {
    "updateAgreementPeriod": {
      "account": AccountType
    }
  }
}

updateAgreementRescission

Type: UpdateAgreementRescission

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an agreement rescission.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAgreementRescissionInput!)

Input fields for updating an agreement rescission.

Return fields

Name Description

agreementRescission (AgreementRescissionType)

The updated agreement rescission instance.

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.

Mutation

mutation UpdateAgreementRescission($input: UpdateAgreementRescissionInput!) {
  updateAgreementRescission(input: $input) {
    agreementRescission {
      ...AgreementRescissionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementRescissionInput
}

Response

{
  "data": {
    "updateAgreementRescission": {
      "agreementRescission": AgreementRescissionType
    }
  }
}

updateAgreementRollover

Type: UpdateAgreementRollover

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an agreement rollover.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAgreementRolloverInput!)

Input for updating an agreement rollover.

Return fields

Name Description

agreementRollover (AgreementRolloverType)

The update agreement rollover.

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.

Mutation

mutation UpdateAgreementRollover($input: UpdateAgreementRolloverInput!) {
  updateAgreementRollover(input: $input) {
    agreementRollover {
      ...AgreementRolloverTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAgreementRolloverInput
}

Response

{
  "data": {
    "updateAgreementRollover": {
      "agreementRollover": AgreementRolloverType
    }
  }
}

updateApiException

Type: UpdateAPIException

URL: https://api.oeg-kraken.energy/v1/graphql/

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

apiException (APIExceptionType)

The updated APIException.

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.

Mutation

mutation UpdateApiException($input: UpdateAPIExceptionInput!) {
  updateApiException(input: $input) {
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionInput
}

Response

{
  "data": {
    "updateApiException": {
      "apiException": APIExceptionType
    }
  }
}

updateApiExceptionNote

Type: UpdateAPIExceptionNote

URL: https://api.oeg-kraken.energy/v1/graphql/

Mutation to update an existing APIExceptionNote instance.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateAPIExceptionNoteInput!)

Input fields for creating an API exception note.

Return fields

Name Description

apiException (APIExceptionType)

The updates APIExceptionNote.

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.

Mutation

mutation UpdateApiExceptionNote($input: UpdateAPIExceptionNoteInput!) {
  updateApiExceptionNote(input: $input) {
    apiException {
      ...APIExceptionTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAPIExceptionNoteInput
}

Response

{
  "data": {
    "updateApiExceptionNote": {
      "apiException": APIExceptionType
    }
  }
}

updateAutoTopUpAmount

Type: UpdateAutoTopUpAmount

URL: https://api.oeg-kraken.energy/v1/graphql/

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

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

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.

schedule (PaymentScheduleType)

The new schedule created.

Mutation

mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
  updateAutoTopUpAmount(input: $input) {
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": UpdateAutoTopUpAmountInput
}

Response

{
  "data": {
    "updateAutoTopUpAmount": {
      "schedule": PaymentScheduleType
    }
  }
}

updateBoostCharge

Type: SmartFlexDeviceInterface

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the boost charge for a specific device.

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:

Arguments

Name Description

input (UpdateBoostChargeInput)

Return fields

Name Description

alerts ([SmartFlexDeviceAlertInterface])

Active alert message(s) for a device, showing the latest first.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

id (ID!)

A UUID that identifies this device registration. Re-registering this device will result in a different ID.

integrationDeviceId (String)

The third-party integration device ID.

name (String)

The user-friendly name for the device.

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

propertyId (String)

The id of the property linked to the device.

provider (ProviderChoices!)

The third-party that enables control of this device.

reAuthenticationState (DeviceReAuthenticationInterface)

The re-authentication state of this device, if applicable.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

Mutation

mutation UpdateBoostCharge($input: UpdateBoostChargeInput) {
  updateBoostCharge(input: $input) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateBoostChargeInput
}

Response

{
  "data": {
    "updateBoostCharge": {
      "alerts": SmartFlexDeviceAlertInterface,
      "deviceType": "BATTERIES",
      "id": "20075569",
      "integrationDeviceId": "47220443",
      "name": "step-travel-since-such-plant",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "preferences": SmartFlexDevicePreferencesInterface,
      "propertyId": "94991119",
      "provider": "BYD",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}

updateCollectionProcessRecordToActive

Type: UpdateCollectionProcessRecordToActive

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the Collection Process Record from raised status to active.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCollectionProcessRecordToActiveInputType!)

Input variables needed for making a collection process record active.

Return fields

Name Description

collectionProcessActivated (UpdateCollectionProcessRecordToActiveOutputType)

Whether the collection process was successfully updated.

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.

Mutation

mutation UpdateCollectionProcessRecordToActive($input: UpdateCollectionProcessRecordToActiveInputType!) {
  updateCollectionProcessRecordToActive(input: $input) {
    collectionProcessActivated {
      ...UpdateCollectionProcessRecordToActiveOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToActiveInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToActive": {
      "collectionProcessActivated": UpdateCollectionProcessRecordToActiveOutputType
    }
  }
}

updateCollectionProcessRecordToComplete

Type: UpdateCollectionProcessRecordToComplete

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the Collection Process Record from raised status to complete.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCollectionProcessRecordToCompleteInputType!)

Input variables needed for making a collection process record complete.

Return fields

Name Description

collectionProcessComplete (UpdateCollectionProcessRecordToCompleteOutputType)

Whether the collection process was successfully updated.

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.

Mutation

mutation UpdateCollectionProcessRecordToComplete($input: UpdateCollectionProcessRecordToCompleteInputType!) {
  updateCollectionProcessRecordToComplete(input: $input) {
    collectionProcessComplete {
      ...UpdateCollectionProcessRecordToCompleteOutputTypeFragment
    }
  }
}

Variables

{
  "input": UpdateCollectionProcessRecordToCompleteInputType
}

Response

{
  "data": {
    "updateCollectionProcessRecordToComplete": {
      "collectionProcessComplete": UpdateCollectionProcessRecordToCompleteOutputType
    }
  }
}

updateCommsDeliveryPreference

Type: UpdateCommsDeliveryPreference

URL: https://api.oeg-kraken.energy/v1/graphql/

Update account communication delivery preference.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account.

Return fields

Name Description

account (AccountInterface)

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.

Mutation

mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
  updateCommsDeliveryPreference(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateCommsDeliveryPreferenceInput
}

Response

{
  "data": {
    "updateCommsDeliveryPreference": {
      "account": AccountInterface
    }
  }
}

updateCommsPreferences

Type: UpdateAccountUserCommsPreferencesMutationPayload

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the comms preferences of the account user (the authenticated user).

Arguments

Name Description

input (UpdateAccountUserCommsPreferencesMutationInput!)

Return fields

Name Description

clientMutationId (String)

commsPreferences (AccountUserCommsPreferences)

emailFormat (String)

errors ([ErrorType])

fontSizeMultiplier (Float)

isOptedInMeterReadingConfirmations (Boolean)

isOptedInToClientMessages (Boolean)

isOptedInToOfferMessages (Boolean)

isOptedInToRecommendedMessages (Boolean)

isOptedInToSmsMessages (Boolean)

isOptedInToThirdPartyMessages (Boolean)

isOptedInToUpdateMessages (Boolean)

isUsingInvertedEmailColours (Boolean)

preferredHoldMusic (String)

Mutation

mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
  updateCommsPreferences(input: $input) {
    clientMutationId
    commsPreferences {
      ...AccountUserCommsPreferencesFragment
    }
    emailFormat
    errors {
      ...ErrorTypeFragment
    }
    fontSizeMultiplier
    isOptedInMeterReadingConfirmations
    isOptedInToClientMessages
    isOptedInToOfferMessages
    isOptedInToRecommendedMessages
    isOptedInToSmsMessages
    isOptedInToThirdPartyMessages
    isOptedInToUpdateMessages
    isUsingInvertedEmailColours
    preferredHoldMusic
  }
}

Variables

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

Response

{
  "data": {
    "updateCommsPreferences": {
      "clientMutationId": "20157873",
      "commsPreferences": AccountUserCommsPreferences,
      "emailFormat": "medical-surface-foot-but-myself",
      "errors": [ErrorType],
      "fontSizeMultiplier": 859.17,
      "isOptedInMeterReadingConfirmations": true,
      "isOptedInToClientMessages": true,
      "isOptedInToOfferMessages": true,
      "isOptedInToRecommendedMessages": true,
      "isOptedInToSmsMessages": true,
      "isOptedInToThirdPartyMessages": true,
      "isOptedInToUpdateMessages": true,
      "isUsingInvertedEmailColours": true,
      "preferredHoldMusic": "news-Mrs-two-individual-charge"
    }
  }
}

updateDcaProceeding

Type: UpdateDCAProceeding

URL: https://api.oeg-kraken.energy/v1/graphql/

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

dcaProceedingUpdateStatus (DCAProceedingUpdateStatus)

Whether the update has been applied.

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.

Mutation

mutation UpdateDcaProceeding($input: UpdateDCAProceedingInputType!) {
  updateDcaProceeding(input: $input) {
    dcaProceedingUpdateStatus {
      ...DCAProceedingUpdateStatusFragment
    }
  }
}

Variables

{
  "input": UpdateDCAProceedingInputType
}

Response

{
  "data": {
    "updateDcaProceeding": {
      "dcaProceedingUpdateStatus": DCAProceedingUpdateStatus
    }
  }
}

updateDeviceGridExport

Type: SmartFlexDeviceInterface

URL: https://api.oeg-kraken.energy/v1/graphql/

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

alerts ([SmartFlexDeviceAlertInterface])

Active alert message(s) for a device, showing the latest first.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

id (ID!)

A UUID that identifies this device registration. Re-registering this device will result in a different ID.

integrationDeviceId (String)

The third-party integration device ID.

name (String)

The user-friendly name for the device.

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

propertyId (String)

The id of the property linked to the device.

provider (ProviderChoices!)

The third-party that enables control of this device.

reAuthenticationState (DeviceReAuthenticationInterface)

The re-authentication state of this device, if applicable.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

Mutation

mutation UpdateDeviceGridExport($input: UpdateDeviceGridExportInput) {
  updateDeviceGridExport(input: $input) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateDeviceGridExportInput
}

Response

{
  "data": {
    "updateDeviceGridExport": {
      "alerts": SmartFlexDeviceAlertInterface,
      "deviceType": "BATTERIES",
      "id": "71470786",
      "integrationDeviceId": "32845904",
      "name": "team-detail-without-happen-generation",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "preferences": SmartFlexDevicePreferencesInterface,
      "propertyId": "55490301",
      "provider": "BYD",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}

updateDeviceSmartControl

Type: SmartFlexDeviceInterface

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (SmartControlInput!)

The input to action the desired device control, i.e. suspend or unsuspend a device.

Return fields

Name Description

alerts ([SmartFlexDeviceAlertInterface])

Active alert message(s) for a device, showing the latest first.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

id (ID!)

A UUID that identifies this device registration. Re-registering this device will result in a different ID.

integrationDeviceId (String)

The third-party integration device ID.

name (String)

The user-friendly name for the device.

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

propertyId (String)

The id of the property linked to the device.

provider (ProviderChoices!)

The third-party that enables control of this device.

reAuthenticationState (DeviceReAuthenticationInterface)

The re-authentication state of this device, if applicable.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

Mutation

mutation UpdateDeviceSmartControl($input: SmartControlInput!) {
  updateDeviceSmartControl(input: $input) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "input": SmartControlInput
}

Response

{
  "data": {
    "updateDeviceSmartControl": {
      "alerts": SmartFlexDeviceAlertInterface,
      "deviceType": "BATTERIES",
      "id": "33085971",
      "integrationDeviceId": "64001741",
      "name": "church-process-art-hot-once",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "preferences": SmartFlexDevicePreferencesInterface,
      "propertyId": "64875346",
      "provider": "BYD",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}

updateDocumentAccessibilityPreference

Type: UpdateDocumentAccessibilityPreference!

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the document accessibility preference for an account.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateDocumentAccessibilityPreferenceInput!)

Input fields for updating document accessibility preference for an account.

Return fields

Name Description

account (AccountType)

Account that was changed.

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.

Mutation

mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
  updateDocumentAccessibilityPreference(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": UpdateDocumentAccessibilityPreferenceInput
}

Response

{
  "data": {
    "updateDocumentAccessibilityPreference": {
      "account": AccountType
    }
  }
}

updateIsChargingDurationCapped

Type: SmartFlexDeviceInterface

URL: https://api.oeg-kraken.energy/v1/graphql/

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

alerts ([SmartFlexDeviceAlertInterface])

Active alert message(s) for a device, showing the latest first.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

id (ID!)

A UUID that identifies this device registration. Re-registering this device will result in a different ID.

integrationDeviceId (String)

The third-party integration device ID.

name (String)

The user-friendly name for the device.

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

propertyId (String)

The id of the property linked to the device.

provider (ProviderChoices!)

The third-party that enables control of this device.

reAuthenticationState (DeviceReAuthenticationInterface)

The re-authentication state of this device, if applicable.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

Mutation

mutation UpdateIsChargingDurationCapped($input: UpdateIsChargingDurationCappedInput) {
  updateIsChargingDurationCapped(input: $input) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateIsChargingDurationCappedInput
}

Response

{
  "data": {
    "updateIsChargingDurationCapped": {
      "alerts": SmartFlexDeviceAlertInterface,
      "deviceType": "BATTERIES",
      "id": "77550025",
      "integrationDeviceId": "82195725",
      "name": "year-town-direction-husband-realize",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "preferences": SmartFlexDevicePreferencesInterface,
      "propertyId": "83850350",
      "provider": "BYD",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}

updateLeadAssignment

Type: UpdateLeadAssignment

URL: https://api.oeg-kraken.energy/v1/graphql/

Update assignment fields for a Lead.

The possible errors that can be raised are:

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

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.

updatedLeadData (JSONString)

Arguments passed.

Mutation

mutation UpdateLeadAssignment($input: UpdateLeadAssignmentInput!) {
  updateLeadAssignment(input: $input) {
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadAssignmentInput
}

Response

{
  "data": {
    "updateLeadAssignment": {
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadDetails

Type: UpdateLeadDetails

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the details of a lead.

The possible errors that can be raised are:

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

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.

updatedLeadData (JSONString)

Arguments passed.

Mutation

mutation UpdateLeadDetails($input: UpdateLeadDetailsInput!) {
  updateLeadDetails(input: $input) {
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadDetailsInput
}

Response

{
  "data": {
    "updateLeadDetails": {
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeadStage

Type: UpdateLeadStage

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the stage of a lead.

The possible errors that can be raised are:

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

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.

updatedLeadData (JSONString)

Arguments passed.

Mutation

mutation UpdateLeadStage($input: UpdateLeadStageInput!) {
  updateLeadStage(input: $input) {
    updatedLeadData
  }
}

Variables

{
  "input": UpdateLeadStageInput
}

Response

{
  "data": {
    "updateLeadStage": {
      "updatedLeadData": {"key": "value"}
    }
  }
}

updateLeaveSupplier

Type: LeaveSupplierUpdated!

URL: https://api.oeg-kraken.energy/v1/graphql/

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

message (String!)

The message to display to the user on leave supplier update.

Mutation

mutation UpdateLeaveSupplier($input: UpdateLeaveSupplierInput!) {
  updateLeaveSupplier(input: $input) {
    message
  }
}

Variables

{
  "input": UpdateLeaveSupplierInput
}

Response

{
  "data": {
    "updateLeaveSupplier": {
      "message": "lead-industry-program-foreign-computer"
    }
  }
}

updateMessageTags

Type: UpdateMessageTags

URL: https://api.oeg-kraken.energy/v1/graphql/

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateMessageTagsInput)

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.

tags ([InkTag!]!)

Confirmed tags.

Mutation

mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
  updateMessageTags(input: $input) {
    tags {
      ...InkTagFragment
    }
  }
}

Variables

{
  "input": UpdateMessageTagsInput
}

Response

{
  "data": {
    "updateMessageTags": {
      "tags": InkTag
    }
  }
}

updateMetadata

Type: UpdateMetadata

URL: https://api.oeg-kraken.energy/v1/graphql/

Update metadata on an object.

The possible errors that can be raised are:

Arguments

Name Description

input (MetadataInput!)

Input fields for updating metadata.

Return fields

Name Description

metadata (Metadata)

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.

Mutation

mutation UpdateMetadata($input: MetadataInput!) {
  updateMetadata(input: $input) {
    metadata {
      ...MetadataFragment
    }
  }
}

Variables

{
  "input": MetadataInput
}

Response

{
  "data": {
    "updateMetadata": {
      "metadata": Metadata
    }
  }
}

updateNotesOnOpportunity

Type: UpdateNotesOnOpportunity

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the notes of an opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateNotesOnOpportunityInput!)

Input to update the note on an opportunity.

Return fields

Name Description

opportunityNumber (String)

The number of the opportunity.

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.

Mutation

mutation UpdateNotesOnOpportunity($input: UpdateNotesOnOpportunityInput!) {
  updateNotesOnOpportunity(input: $input) {
    opportunityNumber
  }
}

Variables

{
  "input": UpdateNotesOnOpportunityInput
}

Response

{
  "data": {
    "updateNotesOnOpportunity": {
      "opportunityNumber": "garden-must-order-choose-success"
    }
  }
}

updateOfferGroupOnOpportunity

Type: UpdateOfferGroupOnOpportunity

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the offer group of an opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateOfferGroupOnOpportunityInput!)

Input to update the offer group on an opportunity.

Return fields

Name Description

opportunityNumber (String)

The number of the opportunity.

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.

Mutation

mutation UpdateOfferGroupOnOpportunity($input: UpdateOfferGroupOnOpportunityInput!) {
  updateOfferGroupOnOpportunity(input: $input) {
    opportunityNumber
  }
}

Variables

{
  "input": UpdateOfferGroupOnOpportunityInput
}

Response

{
  "data": {
    "updateOfferGroupOnOpportunity": {
      "opportunityNumber": "force-decision-least-measure-worry"
    }
  }
}

updateOnSiteJobsAppointment

Type: UpdateOnSiteJobsAppointment

URL: https://api.oeg-kraken.energy/v1/graphql/

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 cancellation_category/cancellation_sub_category.
  • KT-CT-13039: Cancellation fields require CANCELLED status.
  • KT-CT-13045: Failed to update appointment assets.
  • KT-CT-13050: Cannot provide both supply_point_identifier_to_market_name_mapping and supply_point_internal_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

onSiteJobsAppointment (OnSiteJobsAppointmentType)

The Appointment that was updated.

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.

Mutation

mutation UpdateOnSiteJobsAppointment($input: OnSiteJobsUpdateAppointmentInput!) {
  updateOnSiteJobsAppointment(input: $input) {
    onSiteJobsAppointment {
      ...OnSiteJobsAppointmentTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsUpdateAppointmentInput
}

Response

{
  "data": {
    "updateOnSiteJobsAppointment": {
      "onSiteJobsAppointment": OnSiteJobsAppointmentType
    }
  }
}

updateOnSiteJobsRequest

Type: UpdateOnSiteJobsRequest

URL: https://api.oeg-kraken.energy/v1/graphql/

Update an On Site Jobs Request.

The possible errors that can be raised are:

Arguments

Name Description

input (OnSiteJobsUpdateRequestInput!)

The input objects required to update a Request.

Return fields

Name Description

onSiteJobsRequest (OnSiteJobsRequestType)

The updated request.

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.

Mutation

mutation UpdateOnSiteJobsRequest($input: OnSiteJobsUpdateRequestInput!) {
  updateOnSiteJobsRequest(input: $input) {
    onSiteJobsRequest {
      ...OnSiteJobsRequestTypeFragment
    }
  }
}

Variables

{
  "input": OnSiteJobsUpdateRequestInput
}

Response

{
  "data": {
    "updateOnSiteJobsRequest": {
      "onSiteJobsRequest": OnSiteJobsRequestType
    }
  }
}

updateOpportunityAssignment

Type: UpdateOpportunityAssignment

URL: https://api.oeg-kraken.energy/v1/graphql/

Update assignment fields for an Opportunity.

The possible errors that can be raised are:

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

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.

updatedOpportunityData (JSONString)

Arguments passed.

Mutation

mutation UpdateOpportunityAssignment($input: UpdateOpportunityAssignmentInput!) {
  updateOpportunityAssignment(input: $input) {
    updatedOpportunityData
  }
}

Variables

{
  "input": UpdateOpportunityAssignmentInput
}

Response

{
  "data": {
    "updateOpportunityAssignment": {
      "updatedOpportunityData": {"key": "value"}
    }
  }
}

updateOpportunityDetails

Type: UpdateOpportunityDetails

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the details of an opportunity.

The possible errors that can be raised are:

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

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.

updatedData (JSONString)

Arguments updated.

Mutation

mutation UpdateOpportunityDetails($input: UpdateOpportunityDetailsInput!) {
  updateOpportunityDetails(input: $input) {
    updatedData
  }
}

Variables

{
  "input": UpdateOpportunityDetailsInput
}

Response

{
  "data": {
    "updateOpportunityDetails": {
      "updatedData": {"key": "value"}
    }
  }
}

updateOpportunityExtraDetails

Type: UpdateOpportunityExtraDetails

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the extra details of a opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateExtraDetailsInput!)

Input fields for updating the extra details of a opportunity.

Return fields

Name Description

extraDetails (JSONString)

The opportunity's extra details to be added or updated.

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.

Mutation

mutation UpdateOpportunityExtraDetails($input: UpdateExtraDetailsInput!) {
  updateOpportunityExtraDetails(input: $input) {
    extraDetails
  }
}

Variables

{
  "input": UpdateExtraDetailsInput
}

Response

{
  "data": {
    "updateOpportunityExtraDetails": {
      "extraDetails": {"key": "value"}
    }
  }
}

updateOpportunityStage

Type: UpdateOpportunityStage

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the stage of a opportunity.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateOpportunityStageInput!)

Input fields for updating the state of a opportunity.

Return fields

Name Description

message (String)

Placeholder success message for now.

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.

Mutation

mutation UpdateOpportunityStage($input: UpdateOpportunityStageInput!) {
  updateOpportunityStage(input: $input) {
    message
  }
}

Variables

{
  "input": UpdateOpportunityStageInput
}

Response

{
  "data": {
    "updateOpportunityStage": {
      "message": "light-series-floor-management-remember"
    }
  }
}

updatePassword

Type: UpdatePassword

URL: https://api.oeg-kraken.energy/v1/graphql/

Update password of the authenticated user

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdatePasswordInput)

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.

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

Mutation

mutation UpdatePassword($input: UpdatePasswordInput) {
  updatePassword(input: $input) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": UpdatePasswordInput
}

Response

{
  "data": {
    "updatePassword": {
      "viewer": AccountUserType
    }
  }
}

updatePaymentSchedulePaymentAmount

Type: UpdatePaymentSchedulePaymentAmount

URL: https://api.oeg-kraken.energy/v1/graphql/

Update monthly Direct Debit payment amount. Permitted values: 100 cents (1€) - 100,000 cents (1000€).

This field requires the Authorization header to be set.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdatePaymentSchedulePaymentAmountInput!)

Return fields

Name Description

paymentSchedule (PaymentScheduleType)

The payment schedule that is being updated.

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.

Mutation

mutation UpdatePaymentSchedulePaymentAmount($input: UpdatePaymentSchedulePaymentAmountInput!) {
  updatePaymentSchedulePaymentAmount(input: $input) {
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": UpdatePaymentSchedulePaymentAmountInput
}

Response

{
  "data": {
    "updatePaymentSchedulePaymentAmount": {
      "paymentSchedule": PaymentScheduleType
    }
  }
}

updatePaymentSchedulePaymentDay

Type: UpdatePaymentSchedulePaymentDay

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

Arguments

Name Description

input (UpdatePaymentSchedulePaymentDayInput!)

Return fields

Name Description

paymentSchedule (PaymentScheduleType)

The payment schedule that is being updated.

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.

Mutation

mutation UpdatePaymentSchedulePaymentDay($input: UpdatePaymentSchedulePaymentDayInput!) {
  updatePaymentSchedulePaymentDay(input: $input) {
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

Variables

{
  "input": UpdatePaymentSchedulePaymentDayInput
}

Response

{
  "data": {
    "updatePaymentSchedulePaymentDay": {
      "paymentSchedule": PaymentScheduleType
    }
  }
}

updateProductPrices

Type: UpdateProductPricesOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the prices of a product.

The possible errors that can be raised are:

Arguments

Name Description

input (UpdateProductPricesInput!)

Return fields

Name Description

prices ([RateGroupPrices!]!)

The rate group prices.

Mutation

mutation UpdateProductPrices($input: UpdateProductPricesInput!) {
  updateProductPrices(input: $input) {
    prices {
      ...RateGroupPricesFragment
    }
  }
}

Variables

{
  "input": UpdateProductPricesInput
}

Response

{
  "data": {
    "updateProductPrices": {
      "prices": RateGroupPrices
    }
  }
}

updateSiteworksRequest

Type: UpdateSiteworksRequest

URL: https://api.oeg-kraken.energy/v1/graphql/

Update a Request.

The possible errors that can be raised are:

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

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.

siteworksRequest (CoreSiteworksRequestType)

The siteworks request after the update.

Mutation

mutation UpdateSiteworksRequest($input: UpdateSiteworksRequestInputType!) {
  updateSiteworksRequest(input: $input) {
    siteworksRequest {
      ...CoreSiteworksRequestTypeFragment
    }
  }
}

Variables

{
  "input": UpdateSiteworksRequestInputType
}

Response

{
  "data": {
    "updateSiteworksRequest": {
      "siteworksRequest": CoreSiteworksRequestType
    }
  }
}

updateUser

Type: UpdateUserMutation

URL: https://api.oeg-kraken.energy/v1/graphql/

Update the account user details of the authenticated user.

Only one name field can be updated per day, other fields can be updated freely. 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.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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

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.

viewer (AccountUserType)

Mutation

mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": UpdateUserInput
}

Response

{
  "data": {
    "updateUser": {
      "viewer": AccountUserType
    }
  }
}

updateUserDetails

Type: UpdateAccountUserMutationPayload

URL: https://api.oeg-kraken.energy/v1/graphql/

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

clientMutationId (String)

dateOfBirth (Date)

email (String)

errors ([ErrorType])

familyName (String)

givenName (String)

landline (String)

mobile (String)

pronouns (String)

Mutation

mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
  updateUserDetails(input: $input) {
    clientMutationId
    dateOfBirth
    email
    errors {
      ...ErrorTypeFragment
    }
    familyName
    givenName
    landline
    mobile
    pronouns
  }
}

Variables

{
  "input": UpdateAccountUserMutationInput
}

Response

{
  "data": {
    "updateUserDetails": {
      "clientMutationId": "88879310",
      "dateOfBirth": "2020-02-09",
      "email": "somebody-sort-education-process-performance",
      "errors": [ErrorType],
      "familyName": "Calderon",
      "givenName": "Ellen",
      "landline": "along-then-heavy-age-final",
      "mobile": "range-thus-evening-good-throughout",
      "pronouns": "own-worker-whom-land-maybe"
    }
  }
}

Arguments

Name Description

input (ValidateEmailInput!)

Return fields

Name Description

isValid (Boolean)

Whether the email is valid or not.

Mutation

mutation ValidateEmail($input: ValidateEmailInput!) {
  validateEmail(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidateEmailInput
}

Response

{
  "data": {
    "validateEmail": {
      "isValid": true
    }
  }
}

validateMfaDevice

Type: ValidateMfaDevice

URL: https://api.oeg-kraken.energy/v1/graphql/

Validate MFA Device for user.

The possible errors that can be raised are:

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

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

Return fields

Name Description

deviceIsValid (Boolean)

Flag to indicate if the device has been verified, so it can be used for MFA.

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.

Mutation

mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
  validateMfaDevice(input: $input) {
    deviceIsValid
  }
}

Variables

{
  "input": ValidateMfaDeviceInputType
}

Response

{
  "data": {
    "validateMfaDevice": {
      "deviceIsValid": true
    }
  }
}

Arguments

Name Description

input (ValidatePhoneNumberInput!)

Return fields

Name Description

isValid (Boolean)

Whether the phone number is valid or not.

Mutation

mutation ValidatePhone($input: ValidatePhoneNumberInput!) {
  validatePhone(input: $input) {
    isValid
  }
}

Variables

{
  "input": ValidatePhoneNumberInput
}

Response

{
  "data": {
    "validatePhone": {
      "isValid": true
    }
  }
}

varyContractTerms

Type: VaryContractTermsOutput!

URL: https://api.oeg-kraken.energy/v1/graphql/

Vary the terms of a contract.

The possible errors that can be raised are:

Arguments

Name Description

input (VaryContractTermsInput!)

Return fields

Name Description

contract (Contract)

The contract with the varied terms.

Mutation

mutation VaryContractTerms($input: VaryContractTermsInput!) {
  varyContractTerms(input: $input) {
    contract {
      ...ContractFragment
    }
  }
}

Variables

{
  "input": VaryContractTermsInput
}

Response

{
  "data": {
    "varyContractTerms": {
      "contract": Contract
    }
  }
}

verifyCustomer

Type: VerifyCustomer

URL: https://api.oeg-kraken.energy/v1/graphql/

Verify a customer using the provided verification code and type.

The possible errors that can be raised are:

Arguments

Name Description

input (VerifyCustomerInput!)

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.

user (AccountUserType)

The currently authenticated user.

Mutation

mutation VerifyCustomer($input: VerifyCustomerInput!) {
  verifyCustomer(input: $input) {
    user {
      ...AccountUserTypeFragment
    }
  }
}

Variables

{
  "input": VerifyCustomerInput
}

Response

{
  "data": {
    "verifyCustomer": {
      "user": AccountUserType
    }
  }
}

verifyEmail

Type: VerifyEmail

URL: https://api.oeg-kraken.energy/v1/graphql/

Verify user's email address.

The possible errors that can be raised are:

Arguments

Name Description

input (VerifyEmailInput!)

Return fields

Name Description

isVerified (Boolean)

Whether the email is verified.

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.

Mutation

mutation VerifyEmail($input: VerifyEmailInput!) {
  verifyEmail(input: $input) {
    isVerified
  }
}

Variables

{
  "input": VerifyEmailInput
}

Response

{
  "data": {
    "verifyEmail": {
      "isVerified": true
    }
  }
}

verifyIdentity

Type: VerifyIdentity

URL: https://api.oeg-kraken.energy/v1/graphql/

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:

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

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!)

An expiring token that can be used to request to update the user's email address.

Mutation

mutation VerifyIdentity($input: VerifyIdentityInput!) {
  verifyIdentity(input: $input) {
    token
  }
}

Variables

{
  "input": VerifyIdentityInput
}

Response

{
  "data": {
    "verifyIdentity": {
      "token": "happen-hospital-policy-such-all"
    }
  }
}

withdrawDunning

Type: WithdrawDunning

URL: https://api.oeg-kraken.energy/v1/graphql/

Withdraw a dunning process for an account

The possible errors that can be raised are:

Arguments

Name Description

input (WithdrawDunningInputType!)

Input variables needed for withdrawing a dunning process for an account.

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.

withdrawSuccessful (Boolean)

Whether the dunning process was withdrawn successfully.

Mutation

mutation WithdrawDunning($input: WithdrawDunningInputType!) {
  withdrawDunning(input: $input) {
    withdrawSuccessful
  }
}

Variables

{
  "input": WithdrawDunningInputType
}

Response

{
  "data": {
    "withdrawDunning": {
      "withdrawSuccessful": true
    }
  }
}

Authentication Server

createMfaDevice

Type: CreateMfaDevice

URL: https://auth.oeg-kraken.energy/graphql/

Create MFA Device for user.

The possible errors that can be raised are:

Deprecated

The 'createMfaDevice' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Arguments

Name Description

input (CreateMfaDeviceInputType!)

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

Return fields

Name Description

deviceEmail (String)

Email address to send the MFA code by default.

devicePhone (String)

Phone number to send the MFA code by default.

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.

totpSecret (String)

Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually.

Mutation

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

Variables

{
  "input": CreateMfaDeviceInputType
}

Response

{
  "data": {
    "createMfaDevice": {
      "deviceEmail": "yard-technology-notice-long-somebody",
      "devicePhone": "company-street-let-it-whether",
      "totpSecret": "pressure-might-husband-newspaper-leave"
    }
  }
}

deleteMfaDevice

Type: DeleteMfaDevice

URL: https://auth.oeg-kraken.energy/graphql/

Delete MFA Device for user.

The possible errors that can be raised are:

Deprecated

The 'deleteMfaDevice' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

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

Return fields

Name Description

deviceDeleted (Boolean)

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

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.

Mutation

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

Variables

{
  "input": DeleteMfaDeviceInputType
}

Response

{
  "data": {
    "deleteMfaDevice": {
      "deviceDeleted": true
    }
  }
}

validateMfaDevice

Type: ValidateMfaDevice

URL: https://auth.oeg-kraken.energy/graphql/

Validate MFA Device for user.

The possible errors that can be raised are:

Deprecated

The 'validateMfaDevice' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

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

Return fields

Name Description

deviceIsValid (Boolean)

Flag to indicate if the device has been verified, so it can be used for MFA.

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.

Mutation

mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
  validateMfaDevice(input: $input) {
    deviceIsValid
  }
}

Variables

{
  "input": ValidateMfaDeviceInputType
}

Response

{
  "data": {
    "validateMfaDevice": {
      "deviceIsValid": true
    }
  }
}