updateBoostCharge

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)

Arguments

input : UpdateBoostChargeInput

The boost charge action to perform on the device.

Returns

SmartFlexDeviceInterface

Some general information about a device.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Rate Limits

Key	Steps
`user`	['300/h']

Query Complexity

Examples

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

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

{
  "input": UpdateBoostChargeInput
}

{
  "data": {
    "updateBoostCharge": {
      "alerts": SmartFlexDeviceAlertInterface,
      "capabilities": FlexDeviceCapabilityInterface,
      "deviceType": "BATTERIES",
      "id": "87837255",
      "integrationDeviceId": "62290352",
      "name": "deep-resource-form-order-travel",
      "onboardingWizard": SmartFlexOnboardingWizard,
      "preferences": SmartFlexDevicePreferencesInterface,
      "preferenceSetting": FlexDevicePreferenceSettingInterface,
      "propertyId": "20583386",
      "reAuthenticationState": DeviceReAuthenticationInterface,
      "site": FlexSite,
      "status": SmartFlexDeviceStatusInterface
    }
  }
}