Delete Group

Last Updated on : 2024-06-28 22:35:04download

Delete the specified group based on the group ID.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
group_idLongpathtrueThe group ID.

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
task_idStringThe task ID.
task_typeIntegerThe type of tasks. Valid values:
  • 1: Add. For example, create a group.
  • 2: Update. For example, add a device to a group or remove a device from a group.
  • 3: Delete. For example, delete a group.
task_expire_secondLongThe number of seconds after which the task will expire. Do not modify the relationship between the group and the devices until the task is completed.

Request example

DELETE: /v2.1/cloud/thing/group/1393****

Return example

{
    "tid": "122bcc1e022d11efbe7a366d87620758",
    "result": {
        "task_id": "178309439872518****",
        "group_id": "1393****",
        "task_expire_second": 21,
        "task_type": 3
    },
    "t": 1713957807630,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.