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.

API Site

addProperty

Type:AddProperty

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Add a property to an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AddPropertyInput!)

Input fields for adding a property to an account.

Return fields

NameDescription

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
    }
  }
}

assignSupplyPointToEstimationGroup

Type:AssignSupplyPointToEstimationGroup

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AssignSupplyPointToEstimationGroupInput!)

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

Return fields

NameDescription

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
    }
  }
}

backendScreenEvent

Type:BackendScreenEvent

URL:https://api.resiflexeu-kraken.systems/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:

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

Arguments

NameDescription

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

NameDescription

action (ActionType)

An action to perform.

Mutation

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

Variables

{
  "input": BackendScreenEventInput
}

Response

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

cancelSmartFlexOnboarding

Type:CancelSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Cancel onboarding of a device with SmartFlex.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CancelSmartFlexOnboardingInput!)

Return fields

NameDescription

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
    }
  }
}

closeProperty

Type:CloseProperty

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Close a property.

Closes the account's property and deauthenticates the devices on the property.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ClosePropertyInput!)

Input fields for closing a property.

Return fields

NameDescription

propertyId (ID)

The ID of the closed property.

Mutation

mutation CloseProperty($input: ClosePropertyInput!) {
  closeProperty(input: $input) {
    propertyId
  }
}

Variables

{
  "input": ClosePropertyInput
}

Response

{
  "data": {
    "closeProperty": {
      "propertyId": "abc123"
    }
  }
}

completeAuthFlowForSmartFlexOnboarding

Type:CompleteAuthFlowForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Complete the authentication flow 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteAuthFlowInput!)

Return fields

NameDescription

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
    }
  }
}

completeRetryForSmartFlexOnboarding

Type:CompleteRetryForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Complete the Retry step to recreate and retry the previously-failed 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'completeRetryForSmartFlexOnboarding' field is deprecated.

The Retry step is no longer used during onboarding.

- Marked as deprecated on 2026-07-29.
- Scheduled for removal on or after 2027-01-29.

Arguments

NameDescription

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

NameDescription

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation CompleteRetryForSmartFlexOnboarding($input: CompleteSmartFlexOnboardingStepInput!) {
  completeRetryForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": CompleteSmartFlexOnboardingStepInput
}

Response

{
  "data": {
    "completeRetryForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

completeTeslaSetupVirtualKeyForSmartFlexOnboarding

Type:CompleteTeslaSetupVirtualKeyForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UserInputRequiredInput!)

Return fields

NameDescription

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
    }
  }
}

createAccountManualHold

Type:CreateAccountManualHold

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Place a manual billing document hold on an account, preventing billing documents from being issued for the given period.

The possible errors that can be raised are:

  • KT-CT-9710: Account not found.
  • KT-CT-9711: Manual hold reason not found.
  • KT-CT-9712: An overlapping manual hold already exists.
  • KT-CT-9713: Invalid hold validity period.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateAccountManualHoldInput!)

Input fields to create a manual billing hold on an account.

Return fields

NameDescription

accountManualHold (AccountManualHoldType!)

The created manual hold.

Mutation

mutation CreateAccountManualHold($input: CreateAccountManualHoldInput!) {
  createAccountManualHold(input: $input) {
    accountManualHold {
      ...AccountManualHoldTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountManualHoldInput
}

Response

{
  "data": {
    "createAccountManualHold": {
      "accountManualHold": AccountManualHoldType
    }
  }
}

createAccountNote

Type:CreateAccountNote

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Add a note to an account.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateAccountNoteInput!)

Input variables needed for adding a note to an account.

Return fields

NameDescription

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
    }
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": CreateAccountNoteInput
}

Response

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

createAccountReference

Type:CreateAccountReference

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Create an account reference.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

NameDescription

accountReference (AccountReferenceType)

Mutation

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

Variables

{
  "input": AccountReferenceInput
}

Response

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

createFlexShellAccount

Type:CreateFlexShellAccount

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Create a ResiFlex account with minimal information.

ResiFlex accounts are shell accounts that contain only essential data needed for device onboarding and API authentication. Most account management happens in the client's CRM system.

The possible errors that can be raised are:

  • KT-CT-4110: Unable to create account.
  • KT-CT-4131: Invalid brand.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateFlexShellAccountInput!)

Input fields for creating a ResiFlex account.

Return fields

NameDescription

account (AccountType)

The created ResiFlex account.

Mutation

mutation CreateFlexShellAccount($input: CreateFlexShellAccountInput!) {
  createFlexShellAccount(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "input": CreateFlexShellAccountInput
}

Response

{
  "data": {
    "createFlexShellAccount": {
      "account": AccountType
    }
  }
}

createPostEvents

Type:CreatePostEvents

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Create post delivery events from external vendors.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreatePostEventsInput!)

Batch of post events to create.

Return fields

NameDescription

createdEventsCount (Int)

Number of events successfully created.

Mutation

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

Variables

{
  "input": CreatePostEventsInput
}

Response

{
  "data": {
    "createPostEvents": {
      "createdEventsCount": 1
    }
  }
}

deauthenticateDevice

Type:DeauthenticateDevice

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

De-authenticate a registered 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

NameDescription

input (DeAuthenticationInput)

Return fields

NameDescription

krakenflexDevice (DeviceDetailsType)

Mutation

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

Variables

{
  "input": DeAuthenticationInput
}

Response

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

deauthenticateFlexDevice

Type:DeauthenticateFlexDevice

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

De-authenticate a registered 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.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (DeauthenticateFlexDeviceInput)

Return fields

NameDescription

krakenflexDevice (DeviceDetailsType)

Mutation

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

Variables

{
  "input": DeauthenticateFlexDeviceInput
}

Response

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

deleteAccountReference

Type:DeleteAccountReference

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Delete a reference for a particular account and namespace.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DeleteAccountReferenceInput!)

Input fields for removing an account reference.

Return fields

NameDescription

accountReference (DeleteAccountReferenceType)

Mutation

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

Variables

{
  "input": DeleteAccountReferenceInput
}

Response

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

deleteBoostCharge

Type:DeleteBoostCharge

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Stop any active boost charging.

The possible errors that can be raised are:

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

Deprecated

The 'deleteBoostCharge' field is deprecated.

Please use 'updateBoostCharge' instead.

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

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

Arguments

NameDescription

input (DeleteBoostChargeInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

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

Variables

{
  "input": DeleteBoostChargeInput
}

Response

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

deletePushNotificationBinding

Type:DeletePushNotificationBinding

URL:https://api.resiflexeu-kraken.systems/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

NameDescription

input (DeletePushNotificationBindingInput!)

Input fields for deleting a push notification binding.

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

The possible errors that can be raised are:

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

Arguments

NameDescription

input (DetachSupplyPointFromEstimationGroupInput!)

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

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

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

The possible errors that can be raised are:

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

Deprecated

The 'deviceRegistration' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

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

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

Arguments

NameDescription

input (DeviceRegistrationInput)

Return fields

NameDescription

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": ["abc123"]
    }
  }
}

fetchGeneratePaymentFingerprint

Type:FetchGeneratePaymentFingerprint

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Fetch or generate payment fingerprint from vendor.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (FetchGeneratePaymentFingerprintInput!)

Return fields

NameDescription

fingerprint (String)

Fetched or generated fingerprint from vendor.

vendor (String)

Vendor name.

Mutation

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

Variables

{
  "input": FetchGeneratePaymentFingerprintInput
}

Response

{
  "data": {
    "fetchGeneratePaymentFingerprint": {
      "fingerprint": "abc123",
      "vendor": "abc123"
    }
  }
}

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-1135: Invalid data.
  • KT-CT-1134: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (ObtainJSONWebTokenInput!)

Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API.

Return fields

NameDescription

token (String!)

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

payload (GenericScalar!)

The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the token field.

refreshToken (String)

A token that can be used in a subsequent call to obtainKrakenToken to get a new Kraken Token with the same access conditions after the previous one has expired.

refreshExpiresIn (Int)

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

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query 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 ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
  obtainKrakenToken(input: $input) {
    token
    payload
    refreshToken
    refreshExpiresIn
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": ObtainJSONWebTokenInput
}

Response

{
  "data": {
    "obtainKrakenToken": {
      "token": "abc123",
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshToken": "abc123",
      "refreshExpiresIn": 1,
      "possibleErrors": [PossibleErrorType]
    }
  }
}

obtainLongLivedRefreshToken

Type:ObtainLongLivedRefreshToken

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Obtain a long-lived refresh token.

This mutation is limited to authorized third-party organizations only. Account users can only generate short-lived refresh tokens, obtainable from the 'refreshToken' field in the 'obtainKrakenToken' mutation.

The possible errors that can be raised are:

  • KT-CT-1120: The Kraken Token has expired.
  • KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
  • KT-CT-1132: Unauthorized.
  • KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (ObtainLongLivedRefreshTokenInput!)

Input fields for obtaining a long-lived refresh token to extend the expiry claim of a Kraken token.

Return fields

NameDescription

refreshToken (String)

refreshExpiresIn (Int!)

Mutation

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

Variables

{
  "input": ObtainLongLivedRefreshTokenInput
}

Response

{
  "data": {
    "obtainLongLivedRefreshToken": {
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

ocppAuthentication

Type:OCPPAuthentication

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Open Charge Point Protocol (OCPP) authentication.

Take the given OCPP authentication details and trigger OCPP authentication.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • 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

NameDescription

input (OCPPAuthenticationInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

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

Variables

{
  "input": OCPPAuthenticationInput
}

Response

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

registerPushNotificationBinding

Type:RegisterPushNotificationBinding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

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

This field requires the Authorization header to be set.

The possible errors that can be raised are:

  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (RegisterPushNotificationBindingInput!)

Input fields for creating an push notification binding.

Return fields

NameDescription

pushNotificationBinding (PushNotificationBindingType)

Mutation

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

Variables

{
  "input": RegisterPushNotificationBindingInput
}

Response

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

requestPasswordReset

Type:RequestPasswordResetOutputType

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-11331: Invalid input data.
  • KT-CT-11332: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

NameDescription

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": "abc123",
      "userNumber": "abc123"
    }
  }
}

resetUserPassword

Type:ResetUserPasswordOutput

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-4125: Unauthorized.
  • KT-CT-1132: Unauthorized.
  • KT-CT-5450: Password is invalid.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

NameDescription

userId (ID!)

The ID of the user whose password was changed.

passwordUpdated (Boolean)

True if the password update was successful, false otherwise.

Deprecated

The 'passwordUpdated' field is deprecated.

Please handle the KT-CT-5450 error instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

- Marked as deprecated on 2025-04-07.
- Scheduled for removal on or after 2025-10-04.

failureReasons ([String])

A list of messages of which password validations the new password failed against if applicable.

Deprecated

The 'failureReasons' field is deprecated.

Please handle the KT-CT-5450 error and inspect the `validationErrors[].message` extension instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

- Marked as deprecated on 2025-04-07.
- Scheduled for removal on or after 2025-10-04.

failureCodes ([String])

A list of codes of which password validation the new password failed against if applicable. One of: - password_too_short - password_too_common - password_reused - password_matches_current - password_has_too_few_numeric_characters - password_has_too_few_special_characters - password_has_too_few_lowercase_characters - password_has_too_few_uppercase_characters - password_contains_account_number - password_contains_part_of_email_address

Deprecated

The 'failureCodes' field is deprecated.

Please handle the KT-CT-5450 error and inspect the `validationErrors[].code` extension instead.

Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields.

- Marked as deprecated on 2025-04-07.
- Scheduled for removal on or after 2025-10-04.

Mutation

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

Variables

{
  "input": ResetUserPasswordInput
}

Response

{
  "data": {
    "resetUserPassword": {
      "userId": "abc123",
      "passwordUpdated": true,
      "failureReasons": ["abc123"],
      "failureCodes": ["abc123"]
    }
  }
}

resumeControl

Type:ResumeDeviceControl

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Resume control of a device after having been away from home, so that the device can be charged again according to the set preferences.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4359: Unable to resume device control.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'resumeControl' field is deprecated.

Please use 'updateDeviceSmartControl' instead.

- Marked as deprecated on 2024-09-17.
- Scheduled for removal on or after 2025-12-11.

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

Arguments

NameDescription

input (AccountNumberInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

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

Variables

{
  "input": AccountNumberInput
}

Response

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

selectChargePointMakeForSmartFlexOnboarding

Type:SelectChargePointMakeForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Select the charge point make to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectChargePointMakeInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Select the charge point model variant to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectChargePointVariantInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectDeviceTypeInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Select from a list of options presented (in a step that inherits from SelectFromList).

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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SelectFromListInput!)

Return fields

NameDescription

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
    }
  }
}

selectHeatPumpMakeForSmartFlexOnboarding

Type:SelectHeatPumpMakeForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Select the heat pump make to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'selectHeatPumpMakeForSmartFlexOnboarding' field is deprecated.

Please use 'selectFromListForSmartFlexOnboarding' instead.

- Marked as deprecated on 2026-01-05.
- Scheduled for removal on or after 2026-07-05.

Arguments

NameDescription

input (SelectHeatPumpMakeInput!)

Return fields

NameDescription

wizard (SmartFlexOnboardingWizard)

The wizard created for onboarding the device with SmartFlex.

Mutation

mutation SelectHeatPumpMakeForSmartFlexOnboarding($input: SelectHeatPumpMakeInput!) {
  selectHeatPumpMakeForSmartFlexOnboarding(input: $input) {
    wizard {
      ...SmartFlexOnboardingWizardFragment
    }
  }
}

Variables

{
  "input": SelectHeatPumpMakeInput
}

Response

{
  "data": {
    "selectHeatPumpMakeForSmartFlexOnboarding": {
      "wizard": SmartFlexOnboardingWizard
    }
  }
}

selectInverterMakeForSmartFlexOnboarding

Type:SelectInverterMakeForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Select the inverter make to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectInverterMakeInput!)

Return fields

NameDescription

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
    }
  }
}

selectUserVehicleForSmartFlexOnboarding

Type:SelectUserVehicleForSmartFlexOnboarding

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Select the user's vehicle to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectUserVehicleInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Select the vehicle make to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectVehicleMakeInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Select the vehicle or charge point to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SelectVehicleOrChargePointInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Select the vehicle model variant to complete the 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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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

NameDescription

input (SelectVehicleVariantInput!)

Return fields

NameDescription

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
    }
  }
}

setClimateControlState

Type:SetClimateControlState

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Turn a hot water device on or off.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4337: Unable to set climate control state.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (ClimateControlStateInput)

Return fields

NameDescription

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

Mutation

mutation SetClimateControlState($input: ClimateControlStateInput) {
  setClimateControlState(input: $input) {
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": ClimateControlStateInput
}

Response

{
  "data": {
    "setClimateControlState": {
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setDevicePreferences

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Set the user preferences for a device.

The possible errors that can be raised are:

  • KT-CT-4314: Unable to get provider details.
  • KT-CT-4321: Serializer validation error.
  • KT-CT-4374: An error occurred while trying to set your device preferences.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SmartFlexDevicePreferencesInput!)

The device preference details to be updated.

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

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

Variables

{
  "input": SmartFlexDevicePreferencesInput
}

Response

{
  "data": {
    "setDevicePreferences": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

setHotWaterState

Type:SetHotWaterState

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Turn a hot water device on or off.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4336: Unable to set hot water state.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (HotWaterStateInput)

Return fields

NameDescription

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

Mutation

mutation SetHotWaterState($input: HotWaterStateInput) {
  setHotWaterState(input: $input) {
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": HotWaterStateInput
}

Response

{
  "data": {
    "setHotWaterState": {
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setInverterPreferences

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Update the preferences for an inverter device.

The possible errors that can be raised are:

  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4392: An error occurred while trying to update your inverter preferences.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (InverterPreferencesInput)

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

mutation SetInverterPreferences($input: InverterPreferencesInput) {
  setInverterPreferences(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": InverterPreferencesInput
}

Response

{
  "data": {
    "setInverterPreferences": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

setRoomTemperature

Type:SetRoomTemperature

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Turn a hot water device on or off.

The possible errors that can be raised are:

  • KT-CT-4329: Invalid data.
  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4346: Unable to set the room temperature.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (RoomTemperatureInput)

Return fields

NameDescription

heatPumpDevice (HeatPumpDeviceType)

The customer specific heat pump device details.

Mutation

mutation SetRoomTemperature($input: RoomTemperatureInput) {
  setRoomTemperature(input: $input) {
    heatPumpDevice {
      ...HeatPumpDeviceTypeFragment
    }
  }
}

Variables

{
  "input": RoomTemperatureInput
}

Response

{
  "data": {
    "setRoomTemperature": {
      "heatPumpDevice": HeatPumpDeviceType
    }
  }
}

setVehicleChargePreferences

Type:SetVehicleChargingPreferences

URL:https://api.resiflexeu-kraken.systems/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

NameDescription

input (VehicleChargingPreferencesInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

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

Variables

{
  "input": VehicleChargingPreferencesInput
}

Response

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

startReAuthentication

Type:StartReAuthentication

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

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

The possible errors that can be raised are:

  • KT-CT-4321: Serializer validation error.
  • KT-CT-4385: Re-authentication is not supported for this device.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StartReAuthenticationInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/v1/graphql/

Create a wizard for onboarding a device with SmartFlex.

The possible errors that can be raised are:

  • KT-CT-4321: Serializer validation error.
  • KT-CT-4385: Re-authentication is not supported for this device.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (StartSmartFlexOnboardingInput!)

Return fields

NameDescription

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.resiflexeu-kraken.systems/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-4391: This onboarding wizard has been cancelled.
  • KT-CT-1113: Disabled GraphQL field requested.
  • 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-04-03.
- Scheduled for removal on or after 2026-10-03.

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

Arguments

NameDescription

input (CompleteSmartFlexOnboardingStepInput!)

Return fields

NameDescription

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
    }
  }
}

suspendControl

Type:SuspendDeviceControl

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Suspend control of a device while away from home (e.g. on holiday), to prevent charging during that period.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4358: Unable to suspend device control.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'suspendControl' field is deprecated.

Please use 'updateDeviceSmartControl' instead.

- Marked as deprecated on 2024-09-17.
- Scheduled for removal on or after 2025-12-11.

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

Arguments

NameDescription

input (AccountNumberInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

mutation SuspendControl($input: AccountNumberInput) {
  suspendControl(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "suspendControl": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

thirdPartyCompleteDeviceRegistration

Type:ThirdPartyCompleteDeviceRegistration

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Complete the registration of a device if the contract is eligible and the device registration is valid.

The possible errors that can be raised are:

  • KT-CT-4321: Serializer validation error.
  • KT-CT-4322: Unable to complete registration error.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Deprecated

The 'thirdPartyCompleteDeviceRegistration' field is deprecated.

This functionality will no longer be available.

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

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

Arguments

NameDescription

input (CompleteDeviceRegistrationInput)

Return fields

NameDescription

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
    }
  }
}

triggerBoostCharge

Type:PerformBoostCharge

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4356: A boost charge cannot currently be performed.
  • KT-CT-4357: Unable to trigger boost charge.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'triggerBoostCharge' field is deprecated.

Please use 'updateBoostCharge' instead.

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

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

Arguments

NameDescription

input (AccountNumberInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

mutation TriggerBoostCharge($input: AccountNumberInput) {
  triggerBoostCharge(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "triggerBoostCharge": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

triggerTestCharge

Type:PerformTestCharge

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4301: Unable to find device for given account.
  • KT-CT-4362: Device not ready for test charge.
  • KT-CT-4355: Unable to trigger charge.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AccountNumberInput)

Return fields

NameDescription

krakenflexDevice (KrakenFlexDeviceType)

Mutation

mutation TriggerTestCharge($input: AccountNumberInput) {
  triggerTestCharge(input: $input) {
    krakenflexDevice {
      ...KrakenFlexDeviceTypeFragment
    }
  }
}

Variables

{
  "input": AccountNumberInput
}

Response

{
  "data": {
    "triggerTestCharge": {
      "krakenflexDevice": KrakenFlexDeviceType
    }
  }
}

updateAccountReference

Type:UpdateAccountReference

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Update a reference for a particular account and namespace.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

NameDescription

accountReference (AccountReferenceType)

Mutation

mutation UpdateAccountReference($input: AccountReferenceInput!) {
  updateAccountReference(input: $input) {
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

Variables

{
  "input": AccountReferenceInput
}

Response

{
  "data": {
    "updateAccountReference": {
      "accountReference": AccountReferenceType
    }
  }
}

updateBoostCharge

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4354: Unable to cancel boost charge.
  • KT-CT-4356: A boost charge cannot currently be performed.
  • KT-CT-4357: Unable to trigger boost charge.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateBoostChargeInput)

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

mutation UpdateBoostCharge($input: UpdateBoostChargeInput) {
  updateBoostCharge(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateBoostChargeInput
}

Response

{
  "data": {
    "updateBoostCharge": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateCommsDeliveryPreference

Type:UpdateCommsDeliveryPreference

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Update the comms delivery preference for the given account.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4136: Cannot set comms preference to email when account has no email.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account.

Return fields

NameDescription

account (AccountInterface)

Mutation

mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
  updateCommsDeliveryPreference(input: $input) {
    account {
      ...AccountInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateCommsDeliveryPreferenceInput
}

Response

{
  "data": {
    "updateCommsDeliveryPreference": {
      "account": AccountInterface
    }
  }
}

updateCommsPreferences

Type:UpdateAccountUserCommsPreferencesMutationPayload

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Update the comms preferences of the account user (the authenticated user).

The possible errors that can be raised are:

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

Arguments

NameDescription

input (UpdateAccountUserCommsPreferencesMutationInput!)

Return fields

NameDescription

isOptedInToClientMessages (Boolean)

isOptedInToOfferMessages (Boolean)

isOptedInToRecommendedMessages (Boolean)

isOptedInToUpdateMessages (Boolean)

isOptedInToThirdPartyMessages (Boolean)

isOptedInMeterReadingConfirmations (Boolean)

isOptedInToSmsMessages (Boolean)

isUsingInvertedEmailColours (Boolean)

fontSizeMultiplier (Float)

emailFormat (String)

preferredHoldMusic (String)

errors ([ErrorType])

commsPreferences (AccountUserCommsPreferences)

clientMutationId (String)

Mutation

mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
  updateCommsPreferences(input: $input) {
    isOptedInToClientMessages
    isOptedInToOfferMessages
    isOptedInToRecommendedMessages
    isOptedInToUpdateMessages
    isOptedInToThirdPartyMessages
    isOptedInMeterReadingConfirmations
    isOptedInToSmsMessages
    isUsingInvertedEmailColours
    fontSizeMultiplier
    emailFormat
    preferredHoldMusic
    errors {
      ...ErrorTypeFragment
    }
    commsPreferences {
      ...AccountUserCommsPreferencesFragment
    }
    clientMutationId
  }
}

Variables

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

Response

{
  "data": {
    "updateCommsPreferences": {
      "isOptedInToClientMessages": true,
      "isOptedInToOfferMessages": true,
      "isOptedInToRecommendedMessages": true,
      "isOptedInToUpdateMessages": true,
      "isOptedInToThirdPartyMessages": true,
      "isOptedInMeterReadingConfirmations": true,
      "isOptedInToSmsMessages": true,
      "isUsingInvertedEmailColours": true,
      "fontSizeMultiplier": 1.0,
      "emailFormat": "abc123",
      "preferredHoldMusic": "abc123",
      "errors": [ErrorType],
      "commsPreferences": AccountUserCommsPreferences,
      "clientMutationId": "abc123"
    }
  }
}

updateDeviceGridExport

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/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

NameDescription

input (UpdateDeviceGridExportInput)

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

mutation UpdateDeviceGridExport($input: UpdateDeviceGridExportInput) {
  updateDeviceGridExport(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateDeviceGridExportInput
}

Response

{
  "data": {
    "updateDeviceGridExport": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateDeviceSmartControl

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/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:

  • KT-CT-4313: Could not find KrakenFlex device.
  • KT-CT-4314: Unable to get provider details.
  • KT-CT-4387: Could not find the KrakenFlex controller device.
  • KT-CT-4358: Unable to suspend device control.
  • KT-CT-4359: Unable to resume device control.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SmartControlInput!)

The input to action the desired device control, i.e. suspend or unsuspend a device.

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

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

Variables

{
  "input": SmartControlInput
}

Response

{
  "data": {
    "updateDeviceSmartControl": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateIsChargingDurationCapped

Type:SmartFlexDeviceInterface

URL:https://api.resiflexeu-kraken.systems/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

NameDescription

input (UpdateIsChargingDurationCappedInput)

Input fields for updating the charging duration cap preference.

Return fields

NameDescription

id (ID!)

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

name (String)

The user-friendly name for the device.

deviceType (KrakenFlexDeviceTypes!)

The type of device.

provider (ProviderChoices!)

The third-party that enables control of this device.

integrationDeviceId (String)

The third-party integration device ID.

status (SmartFlexDeviceStatusInterface!)

Information about the current status of this device.

propertyId (String)

The id of the property linked to the device.

alerts ([SmartFlexDeviceAlertInterface])

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

onboardingWizard (SmartFlexOnboardingWizard)

The current onboarding wizard for a device.

preferences (SmartFlexDevicePreferencesInterface)

The device's preference details.

preferenceSetting (FlexDevicePreferenceSettingInterface)

The preference setting for this device.

reAuthenticationState (DeviceReAuthenticationInterface)

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

Mutation

mutation UpdateIsChargingDurationCapped($input: UpdateIsChargingDurationCappedInput) {
  updateIsChargingDurationCapped(input: $input) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
  }
}

Variables

{
  "input": UpdateIsChargingDurationCappedInput
}

Response

{
  "data": {
    "updateIsChargingDurationCapped": {
      "id": "abc123",
      "name": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BMW",
      "integrationDeviceId": "abc123",
      "status": SmartFlexDeviceStatusInterface,
      "propertyId": "abc123",
      "alerts": SmartFlexDeviceAlertInterface,
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "reAuthenticationState": DeviceReAuthenticationInterface
    }
  }
}

updateOptionsLanguagePreference

Type:UpdateOptionsLanguagePreference

URL:https://api.resiflexeu-kraken.systems/v1/graphql/

Update the language preference for an account. Determines the language in which communications about the account are sent. It does not affect the language seen in the UI.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (OptionsLanguagePreferenceInput!)

Variables needed to update the language preference for an account.

Return fields

NameDescription

optionsLanguagePreference (OptionsLanguagePreferenceChoices)

The selected language preference.

Mutation

mutation UpdateOptionsLanguagePreference($input: OptionsLanguagePreferenceInput!) {
  updateOptionsLanguagePreference(input: $input) {
    optionsLanguagePreference
  }
}

Variables

{
  "input": OptionsLanguagePreferenceInput
}

Response

{
  "data": {
    "updateOptionsLanguagePreference": {
      "optionsLanguagePreference": "ENGLISH"
    }
  }
}

updateUser

Type:UpdateUserMutation

URL:https://api.resiflexeu-kraken.systems/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:

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

Arguments

NameDescription

input (UpdateUserInput!)

Input fields for updating user.

Return fields

NameDescription

viewer (AccountUserType)

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query 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 UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    viewer {
      ...AccountUserTypeFragment
    }
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

{
  "input": UpdateUserInput
}

Response

{
  "data": {
    "updateUser": {
      "viewer": AccountUserType,
      "possibleErrors": [PossibleErrorType]
    }
  }
}