Modify Properties

Last Updated on : 2024-06-28 06:30:46Copy for LLMView as MarkdownDownload PDF

Based on the device ID, modify the property status reported by the device to the cloud. Currently, you can only modify the custom name of a property.

API address

POST: /v2.0/cloud/thing/{device_id}/shadow/properties

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Description of body

Parameter name	Type	IN	Required	Description
properties	List		true	The list of the device property objects.

Description of properties

Parameter name	Type	IN	Required	Description
code	String		true	The code of the specified property.
custom_name	String		true	The custom name of the specified property.

Parameter name	Type	Description
result	Boolean	The returned result. Valid values: `true`: The operation succeeded. `false`: The operation failed.

POST: /v2.0/cloud/thing/372817193*****/shadow/properties

{
  "properties": [
    {
      "code": "switch_led",
      "custom_name": "switch_led1"
    }
  ]
}

{
    "result": true,
    "t": 1591872112140,
    "success": true
}

For more information, see error code.