Module Action

Purpose

To perform a specific action on records based on the given action type.

Endpoints

CopiedGET /iot/v1/{module-api-name}/2000000070908/actions/{action-type}

Request Details

Request URL

{{api-domain}}/iot/v1/{module-api-name}/{record-id}/actions/{action-type}

Supported modules

Devices, Assets, Locations, Alarms, Datapoints, Products, Manufacturers, Vendors, Certificates, Policies, Commands, Users.

Headers

Authorization: Zoho-oauthtoken {{oauth}}

Scope

scope=ZohoIOT.modules.{module_name}.{operation_type}

Possible module names

devices, assets, locations, alarms, datapoints, products, manufacturers, vendors, certificates, policies, commands, users.

Possible action type

delete, download, activate, deactivate, associate, disassociate, etc.

Possible operation types

ALL - Full access to the record
UPDATE - Update records in the module
DELETE - Delete records from the module

Sample Request: First API Call

Copiedcurl --location -g '{{api-domain}}/iot/v1/certificates/2000000070908/actions/delete' \
--header 'Authorization: Zoho-oauthtoken {{oauth}}' \
--header 'Range: 1-1'

Sample Response

Copied{
    "certificates": [
        {
            "code": "SUCCESS",
            "id": "1000000094328",
            "message": "Certificate deleted",
            "status": "success"
        }
    ]
}