Modify Group Information

Last Updated on : 2024-06-29 02:25:42download

Modify the name and other information of the specified group based on the group ID.

API address

PUT: /v2.1/cloud/thing/group/{group_id}

Request parameter

Parameter nameTypeINRequiredDescription
group_idLongpathtrueThe group ID.

Description of body

Parameter nameTypeINRequiredDescription
group_nameStringbodyfalseThe name of the specified group.
product_idStringbodyfalseThe product ID (PID). Modifying the PID will change the group icon.

Return parameter

Parameter nameTypeDescription
resultJsonObjectThe returned result of the specified group.
successBooleanIndicates whether the API is called successfully. Valid values:
  • true: The API call succeeded.
  • false: The API call failed.
tLongThe timestamp.
tidStringThe link ID.

Description of result

Parameter nameTypeDescription
resultBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.

Request example

PUT: /v2.1/cloud/thing/group/1393****
{
  "group_name": "testUpdateGroup****",
  "product_id": "oftxwukuvzoc****"
}

Return example

{
    "tid": "a96cf809021611efbe7a366d87620758",
    "result": {
        "result": true
    },
    "t": 1713948182816,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.