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

addNoteToInkConversation

Type:AddNoteToInkConversation

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AddNoteToInkConversationInput)

Input for adding a note to a conversation.

Return fields

NameDescription

note (InkNote)

The ink conversation note.

Mutation

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

Variables

{
  "input": AddNoteToInkConversationInput
}

Response

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

addProperty

Type:AddProperty

URL:https://api.resiflexna-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
    }
  }
}

addStorylineToInkConversation

Type:AddStorylineToInkConversation

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AddStorylineToInkConversationInput)

Input for adding a storyline to a conversation.

Return fields

NameDescription

storyline (InkStoryline)

The storyline that was added to the conversation.

Mutation

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

Variables

{
  "input": AddStorylineToInkConversationInput
}

Response

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

assignInkBucket

Type:AssignInkBucket

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AssignInkBucketInput)

Input for assigning an conversation to a Bucket.

Return fields

NameDescription

conversation (InkConversation!)

The conversation that will be assigned to the bucket.

bucket (InkBucket!)

The bucket that the conversation will be assigned to.

Mutation

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

Variables

{
  "input": AssignInkBucketInput
}

Response

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

assignSupplyPointToEstimationGroup

Type:AssignSupplyPointToEstimationGroup

URL:https://api.resiflexna-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
    }
  }
}

associateArchivedCallRecordingsWithCalls

Type:AssociateArchivedCallRecordingsWithCalls

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

The possible errors that can be raised are:

  • KT-CT-11818: Invalid archived call recordings input.
  • KT-CT-11820: Too many recordings to associate in a single request.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (AssociateArchivedCallRecordingsWithCallsInput!)

Input for associating archived call recordings with calls.

Return fields

NameDescription

summary (AssociateArchivedRecordingsSummaryType)

Summary counts of the processing results.

results ([AssociateArchivedRecordingResultType])

Per-recording processing results.

Mutation

mutation AssociateArchivedCallRecordingsWithCalls($input: AssociateArchivedCallRecordingsWithCallsInput!) {
  associateArchivedCallRecordingsWithCalls(input: $input) {
    summary {
      ...AssociateArchivedRecordingsSummaryTypeFragment
    }
    results {
      ...AssociateArchivedRecordingResultTypeFragment
    }
  }
}

Variables

{
  "input": AssociateArchivedCallRecordingsWithCallsInput
}

Response

{
  "data": {
    "associateArchivedCallRecordingsWithCalls": {
      "summary": AssociateArchivedRecordingsSummaryType,
      "results": [AssociateArchivedRecordingResultType]
    }
  }
}

associateCallWithAccount

Type:AssociateCallWithAccount

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (AssociateCallWithAccountInput!)

Return fields

NameDescription

call (InboundCallType)

The call.

Mutation

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

Variables

{
  "input": AssociateCallWithAccountInput
}

Response

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

backendScreenEvent

Type:BackendScreenEvent

URL:https://api.resiflexna-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.resiflexna-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
    }
  }
}

closeInkConversation

Type:CloseInkConversation

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CloseInkConversationInput)

Input for closing an Ink conversation.

Return fields

NameDescription

conversation (InkConversation)

The conversation that was closed.

Mutation

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

Variables

{
  "input": CloseInkConversationInput
}

Response

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

closeInkLiveChat

Type:CloseInkLiveChatConversation

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CloseInkLiveChaConversationtInput)

Input for closing a live-chat conversation.

Return fields

NameDescription

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

Mutation

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

Variables

{
  "input": CloseInkLiveChaConversationtInput
}

Response

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

completeAuthFlowForSmartFlexOnboarding

Type:CompleteAuthFlowForSmartFlexOnboarding

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

connectAiAgentToCall

Type:ConnectAiAgentToCall

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (ConnectAiAgentToCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call the AI agent was connected to.

Mutation

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

Variables

{
  "input": ConnectAiAgentToCallInput
}

Response

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

createAccountFileAttachment

Type:CreateAccountFileAttachmentPayload!

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

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

Return fields

NameDescription

Mutation

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

Variables

{
  "input": CreateAccountFileAttachmentInput
}

Response

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

createAccountManualHold

Type:CreateAccountManualHold

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

createCallMetadata

Type:CreateCallMetadata

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CallMetadataInput!)

Return fields

NameDescription

call (CallInterface)

The call metadata was attached to.

Mutation

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

Variables

{
  "input": CallMetadataInput
}

Response

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

createCampaignItems

Type:CreateCampaignItems

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateCampaignItemsInput!)

Return fields

NameDescription

campaignItems ([VoiceCampaignItemType])

batchIdentifier (String)

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

Mutation

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

Variables

{
  "input": CreateCampaignItemsInput
}

Response

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

createInboundCall

Type:CreateInboundCall

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateInboundCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call that was created.

Mutation

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

Variables

{
  "input": CreateInboundCallInput
}

Response

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

createInkInboundMessage

Type:CreateInkInboundMessage

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

Register an Ink inbound message.

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateInkInboundMessageInput)

Input for creating and ingesting an inbound message.

Return fields

NameDescription

message (InkMessage!)

The Ink message that was created.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

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

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

Mutation

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

Variables

{
  "input": CreateInkInboundMessageInput
}

Response

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

createInkLiveChatMessage

Type:CreateInkLiveChatMessage

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (CreateInkLiveChatMessageInput)

Input for creating a live chat message.

Return fields

NameDescription

liveChatConversation (InkLiveChatConversation)

The live chat conversation.

messageRelayId (String!)

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

Mutation

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

Variables

{
  "input": CreateInkLiveChatMessageInput
}

Response

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

createPostEvents

Type:CreatePostEvents

URL:https://api.resiflexna-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
    }
  }
}

createShellAccount

Type:CreateShellAccountPayload

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

Create a shell account (a billable account with no property/energy supply).

The possible errors that can be raised are:

  • KT-CT-4125: Unauthorized.
  • KT-CT-4131: Invalid brand.
  • KT-CT-4132: Period length must be MONTHLY, QUARTERLY or not set.
  • KT-CT-4133: Period day must be set if period is MONTHLY.
  • KT-CT-4134: Period day must be set if period is QUARTERLY.
  • KT-CT-4135: Period month must be set if period is QUARTERLY.
  • KT-CT-4138: Period day must be set if period multiplier > 1.
  • KT-CT-4139: Period month must be set if period multiplier > 1.
  • KT-CT-4141: Quarterly billing periods can't have period multiplier > 1.
  • KT-CT-4142: Missing business details info.
  • KT-CT-4143: Invalid companyName.
  • KT-CT-4144: Invalid companyNumber.
  • KT-CT-4120: Invalid urn.
  • KT-CT-4177: Unauthorized.
  • KT-CT-9403: Received an invalid portfolioId.
  • KT-CT-9405: User not associated to portfolio.
  • KT-CT-9406: Multiple users are associated with the portfolio.
  • KT-CT-9411: Brand does not match the portfolio's brand.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (CreateShellAccountInput!)

Input fields for creating a shell account.

Return fields

NameDescription

account (AccountInterface)

clientMutationId (String)

A unique identifier for the client performing the mutation.

email (String!)

The email address of the account user.

givenName (String!)

The given name of the account user.

familyName (String!)

The family name of the account user.

mobile (String)

The mobile number of the account user.

billingAddressLine1 (String)

First line of the billing address.

billingAddressLine2 (String)

Second line of the billing address.

billingAddressLine3 (String)

Third line of the billing address.

billingAddressLine4 (String)

Fourth line of the billing address.

billingAddressLine5 (String)

Fifth line of the billing address.

billingPostcode (String)

The billing address postcode.

isBusinessAccount (Boolean)

Whether this is a business account.

urn (String)

Unique reference number from a 3rd party enrolment.

portfolioNumber (String)

The portfolio number associated with the account.

billingName (String)

The name to use for billing purposes.

brand (String)

The brand associated with the account.

dateOfBirth (Date)

The user's date of birth.

billingRichAddress (String)

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

billingPeriodLength (String)

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

billingPeriodMultiplier (Int)

For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing.

billingPeriodDay (Int)

Day to fixed bill on if billingperiodlength set.

billingPeriodMonth (Int)

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

companyName (String)

The name of the company for business accounts.

companyNumber (String)

The company registration number for business accounts.

businessType (String)

The type of business for business accounts.

taxNumber (String)

The tax number for the business account.

password (String)

The password for the account user.

passwordUpdateToken (String)

Token required to set a password during account creation.

landline (String)

The user's landline phone number.

errors ([ErrorType])

A list of validation errors.

Mutation

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

Variables

{
  "input": CreateShellAccountInput
}

Response

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

deauthenticateDevice

Type:DeauthenticateDevice

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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"]
    }
  }
}

enqueueInboundCall

Type:EnqueueInboundCall

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (EnqueueInboundCallInput!)

Return fields

NameDescription

call (InboundCallType)

The call that was enqueued.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

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

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

Mutation

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

Variables

{
  "input": EnqueueInboundCallInput
}

Response

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

escalateInkConversation

Type:EscalateInkConversation

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

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-7659: The Ink conversation could not be escalated.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (EscalateInkConversationInput)

Input for escalating an Ink conversation to the team leader.

Return fields

NameDescription

conversationRelayId (ID!)

The ID of the conversation that was escalated.

Mutation

mutation EscalateInkConversation($input: EscalateInkConversationInput) {
  escalateInkConversation(input: $input) {
    conversationRelayId
  }
}

Variables

{
  "input": EscalateInkConversationInput
}

Response

{
  "data": {
    "escalateInkConversation": {
      "conversationRelayId": "abc123"
    }
  }
}

fetchGeneratePaymentFingerprint

Type:FetchGeneratePaymentFingerprint

URL:https://api.resiflexna-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"
    }
  }
}

generateInkPresignedUrl

Type:GenerateInkPresignedUrl

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (GenerateInkPresignedUrlInput)

Input for generating a presigned URL.

Return fields

NameDescription

uploadUrl (String!)

A presigned URL for the user to upload to the quarantine bucket.

key (String!)

The key for the item.

fields (JSONString!)

Presigned post fields required to upload the file.

Mutation

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

Variables

{
  "input": GenerateInkPresignedUrlInput
}

Response

{
  "data": {
    "generateInkPresignedUrl": {
      "uploadUrl": "abc123",
      "key": "abc123",
      "fields": {"key": "value"}
    }
  }
}

moveToBucket

Type:MoveToBucket

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

The possible errors that can be raised are:

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

Arguments

NameDescription

input (MoveToBucketInput)

Input for moving a conversation to a bucket.

Return fields

NameDescription

conversation (InkConversation!)

The conversation that was moved to the bucket.

Mutation

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

Variables

{
  "input": MoveToBucketInput
}

Response

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

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

removeCampaignItems

Type:RemoveCampaignItems

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

The possible errors that can be raised are:

  • KT-CT-11501: Voice campaign not found.
  • KT-CT-11502: Cannot remove items from multiple campaigns at once.
  • KT-CT-11505: Voice campaign item not found.
  • KT-CT-11506: Invalid campaign ID.
  • KT-CT-11507: Invalid campaign item ID.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (RemoveCampaignItemsInput!)

Return fields

NameDescription

campaignItems ([VoiceCampaignItemType])

Mutation

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

Variables

{
  "input": RemoveCampaignItemsInput
}

Response

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

requestPasswordReset

Type:RequestPasswordResetOutputType

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

selectInverterMakeForSmartFlexOnboarding

Type:SelectInverterMakeForSmartFlexOnboarding

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

sendInkOutboundMessage

Type:SendInkOutboundMessage

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

Send an Ink outbound message.

The possible errors that can be raised are:

  • KT-CT-7625: Invalid email address.
  • KT-CT-7650: Cannot send messages to internal handles.
  • KT-CT-7670: Invalid mutation input.
  • KT-CT-7671: Could not send message.
  • KT-CT-7672: Invalid outbound handle.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (SendInkOutboundMessageInput)

Input for sending an Ink outbound message.

Return fields

NameDescription

message (InkMessage!)

The Ink message that was enqueued for sending.

Mutation

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

Variables

{
  "input": SendInkOutboundMessageInput
}

Response

{
  "data": {
    "sendInkOutboundMessage": {
      "message": InkEmail
    }
  }
}

setDevicePreferences

Type:SmartFlexDeviceInterface

URL:https://api.resiflexna-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.

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

setInverterPreferences

Type:SmartFlexDeviceInterface

URL:https://api.resiflexna-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
    }
  }
}

setVehicleChargePreferences

Type:SetVehicleChargingPreferences

URL:https://api.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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.resiflexna-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
    }
  }
}

triggerPostUploadOperations

Type:TriggerPostUploadOperations!

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

The possible errors that can be raised are:

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

Arguments

NameDescription

s3Key (String!)

Return fields

NameDescription

Mutation

mutation TriggerPostUploadOperations($s3Key: String!) {
  triggerPostUploadOperations(s3Key: $s3Key) {
    operationsTriggered
  }
}

Variables

{
  "s3Key": "abc123"
}

Response

{
  "data": {
    "triggerPostUploadOperations": {
      "operationsTriggered": true
    }
  }
}

triggerTestCharge

Type:PerformTestCharge

URL:https://api.resiflexna-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.resiflexna-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
    }
  }
}

updateAccountUserConsents

Type:UpdateAccountUserConsents

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

Update the consents of an account user (the authenticated user)

The possible errors that can be raised are:

  • KT-CT-9014: Duplicate consent.
  • KT-CT-9016: Consent management not enabled.
  • KT-CT-9017: Consent type not found.
  • KT-CT-1111: Unauthorized.
  • KT-CT-5421: Account user not found.
  • KT-CT-5422: Invalid data.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

consents ([ConsentTypeInput])

Consents to update for account user.

userNumber (String)

User number of the account user to update consents for. Only needed if the viewer is an organization.

Return fields

NameDescription

accountUserConsents (AccountUserConsents)

All the consents for an account user.

Mutation

mutation UpdateAccountUserConsents(
  $consents: [ConsentTypeInput],
  $userNumber: String
) {
  updateAccountUserConsents(
    consents: $consents,
    userNumber: $userNumber
  ) {
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

Variables

{
  "consents": ConsentTypeInput,
  "userNumber": "abc123"
}

Response

{
  "data": {
    "updateAccountUserConsents": {
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateBoostCharge

Type:SmartFlexDeviceInterface

URL:https://api.resiflexna-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.

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.resiflexna-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.resiflexna-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

commsPreferences (AccountUserCommsPreferences)

clientMutationId (String)

A unique identifier for the client performing the mutation.

isOptedInToClientMessages (Boolean)

isOptedInToOfferMessages (Boolean)

isOptedInToRecommendedMessages (Boolean)

isOptedInToUpdateMessages (Boolean)

isOptedInToThirdPartyMessages (Boolean)

isOptedInToSmsMessages (Boolean)

isOptedInMeterReadingConfirmations (Boolean)

isUsingInvertedEmailColours (Boolean)

fontSizeMultiplier (Float)

emailFormat (String)

preferredHoldMusic (String)

errors ([ErrorType])

A list of validation errors.

Mutation

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

Variables

{
  "input": UpdateAccountUserCommsPreferencesMutationInput
}

Response

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

updateDeviceGridExport

Type:SmartFlexDeviceInterface

URL:https://api.resiflexna-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.resiflexna-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.

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

updateMessageTags

Type:UpdateMessageTags

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

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-7614: The Ink tag was not found.
  • KT-CT-1113: Disabled GraphQL field requested.
  • KT-CT-1111: Unauthorized.
  • KT-CT-1112: 'Authorization' header not provided.

Arguments

NameDescription

input (UpdateMessageTagsInput)

Input for updating the tags of a message.

Return fields

NameDescription

tags ([InkTag!]!)

Confirmed tags.

Mutation

mutation UpdateMessageTags($input: UpdateMessageTagsInput) {
  updateMessageTags(input: $input) {
    tags {
      ...InkTagFragment
    }
  }
}

Variables

{
  "input": UpdateMessageTagsInput
}

Response

{
  "data": {
    "updateMessageTags": {
      "tags": InkTag
    }
  }
}

updateOptionsLanguagePreference

Type:UpdateOptionsLanguagePreference

URL:https://api.resiflexna-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.resiflexna-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]
    }
  }
}