Update Device Type

This endpoints updates certain fields of the Device Type specified in the body.

Request

To update all attributes of a specific Device Type please make a PATCH request to the following URL:

HTTP MethodURL
PATCHhttps://industrial.api.ubidots.com/api/v2.0/device_types/<device_type_key>/

Path Parameters

ParameterTypeDescription
device_type_keyStringThe id or label of the Device Type, label should use the prefix ~

Query Parameters

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.
pageNumberPaginationReturns the corresponding page of the result
page_sizeNumberPaginationNumber of items per page, if not provided takes default values of 50 (for variables 200)
created_atStringSortSort all Variables based on date created. Default descending.
labelStringSortSort by label
nameStringSortSort by name

Body Parameters

ParameterTypeRequired?Description
nameStringNoName of Device Type
labelStringNoLabel of Device Type
descriptionStringNoDescription of Device Type
deviceColorStringNoHTML Color of Device related to Device Type
deviceIconStringNoIcon of Device related to Device Type
variableColorStringNoColor of Variable related to Device Type
syntheticVariableColorStringNoColor of Synthetic Variable related to Device Type
variablesObjectNoVariables related to Device Type
propertiesObjectNoProperties of Device Type
tasksObjectNoTasks of Device Type

Header

ParameterRequired?Description
X-Auth-HeaderYesAuthentication Token of account
$ curl -X PATCH
'https://industrial.api.ubidots.com/api/v2.0/device_types/<device_type_key>/' \
 -H 'Content-Type: application/json' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73'
 -d ' {
    "name": "el type aquel",
    "label": "el-type-quel",
    "description": "La description aquella",
    "deviceColor": "#3BA9F5",
    "deviceIcon": "pencil",
    "variableColor": "#FFAE58",
    "syntheticVariableColor": "#",
    "variables": [],
    "properties": [],
    "tasks": []
}'
{
    "url": "https://industrial.api.ubidots.com/api/v2.0/device_types/5e1f7e5789f9bd7c4e7f1e2c",
    "id": "5e1f7e5789f9bd7c4e7f1e2c",
    "name": "el type aquel",
    "label": "el-type-quel",
    "description": "La description aquella",
    "deviceColor": "#3BA9F5",
    "deviceIcon": "pencil",
    "variableColor": "#FFAE58",
    "syntheticVariableColor": "#",
    "variables": [],
    "properties": [],
    "tasks": [],
    "createdAt": "2020-01-15T21:04:23.602975Z"
}
{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}
{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}

Response

Returns a Device Type object with the updated Device Type.