Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview
Overview

Arguments

deviceGroupId
ID!,non-nullrequired

Return type

DeviceGroupDeletePayload
Mutation sample
mutation deviceGroupDelete($deviceGroupId: ID!) {
  deviceGroupDelete(deviceGroupId: $deviceGroupId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
isArmed
Boolean!,non-nullrequired
disarmTimeout
Int

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetArmed(
  $deviceGroupId: ID!
  $isArmed: Boolean!
  $disarmTimeout: Int
) {
  deviceGroupSetArmed(
    deviceGroupId: $deviceGroupId
    isArmed: $isArmed
    disarmTimeout: $disarmTimeout
  ) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isArmed": true, "disarmTimeout": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
brightness
Float!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetBrightness($deviceGroupId: ID!, $brightness: Float!) {
  deviceGroupSetBrightness(deviceGroupId: $deviceGroupId, brightness: $brightness) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "brightness": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
color
DeviceSetColorInput!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetColor($deviceGroupId: ID!, $color: DeviceSetColorInput!) {
  deviceGroupSetColor(deviceGroupId: $deviceGroupId, color: $color) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "color": { "hue": 40, "saturation": 40 } }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
isOn
Boolean!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetOnOff($deviceGroupId: ID!, $isOn: Boolean!) {
  deviceGroupSetOnOff(deviceGroupId: $deviceGroupId, isOn: $isOn) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isOn": true }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
openPercent
Float!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetOpenPercent($deviceGroupId: ID!, $openPercent: Float!) {
  deviceGroupSetOpenPercent(deviceGroupId: $deviceGroupId, openPercent: $openPercent) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "openPercent": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
isUnlocked
Boolean!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetUnlocked($deviceGroupId: ID!, $isUnlocked: Boolean!) {
  deviceGroupSetUnlocked(deviceGroupId: $deviceGroupId, isUnlocked: $isUnlocked) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isUnlocked": true }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
childLock
Boolean!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetChildLock($deviceGroupId: ID!, $childLock: Boolean!) {
  deviceGroupSetChildLock(deviceGroupId: $deviceGroupId, childLock: $childLock) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "childLock": true }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
temperature
Float!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetTemperature($deviceGroupId: ID!, $temperature: Float!) {
  deviceGroupSetTemperature(deviceGroupId: $deviceGroupId, temperature: $temperature) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "temperature": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
temperature
Float!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetTemperaturePercentage($deviceGroupId: ID!, $temperature: Float!) {
  deviceGroupSetTemperaturePercentage(deviceGroupId: $deviceGroupId, temperature: $temperature) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "temperature": 40 }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

deviceGroupId
ID!,non-nullrequired
climateMode
ClimateMode!,non-nullrequired

Return type

DeviceGroupTriggerCommandPayload
commandId
ID
Mutation sample
mutation deviceGroupSetClimateMode($deviceGroupId: ID!, $climateMode: ClimateMode!) {
  deviceGroupSetClimateMode(deviceGroupId: $deviceGroupId, climateMode: $climateMode) {
    commandId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "deviceGroupId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "climateMode": "AUTO" }
Response sample
{ "data": { "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview
Overview
Overview
Overview
Overview
Overview
Overview