Skip to content
SENS Platform Docs

Update a device type without changing its key.

PATCH
/v1/device-types/{deviceTypeId}
curl --request PATCH \
  --url https://api.dev.iot-sens.schlossers.at/v1/device-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "status": "active", "metadata": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
deviceTypeId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
>= 1 properties
name
string
>= 1 characters <= 200 characters
status
string
Allowed values: active disabled
metadata
object
<= 50 properties
key
additional properties
One of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Device type updated.

Media typeapplication/json
object
deviceTypeId
required
string format: uuid
tenantId
required
string format: uuid
key
required
string
/^[a-z0-9][a-z0-9_-]{0,63}$/
name
required
string
>= 1 characters <= 200 characters
status
required
string
Allowed values: active disabled
flowId
required
One of:
string format: uuid
activeFlowVersionNumber
required
integer | null
>= 1
deviceCount
required

Count within the caller’s visible device scope.

integer
activeDeviceCount
required

Active count within the caller’s visible device scope.

integer
metadata
required
object
<= 50 properties
key
additional properties
One of:
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "status": "active"
}

default

Section titled “default”

A safe platform error response.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED AUTHENTICATION_FAILED AUTHORIZATION_FAILED RESOURCE_NOT_FOUND CONFLICT DEPENDENCY_FAILURE FLOW_FAILURE RATE_LIMITED INTERNAL_ERROR
category
required
string
Allowed values: validation authentication authorization not_found conflict dependency_failure flow_failure rate_limit internal
message
required

Safe client-facing diagnostic message.

string
correlationId
required

Correlation ID for operational investigation.

string
>= 1 characters
details

Safe bounded diagnostic details.

object
key
additional properties
One of:
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED",
    "category": "validation"
  }
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store