Partially update set

patch

https://api.sensos.io/v1/accounts/{accountId}/sets/{setId}

Partial update. Fields you omit are left unchanged; a field sent as explicit null is cleared. Send nested objects in full. Returns the updated set.

deviceConfiguration can't be cleared once set (400).
The default set can't have matchCriteria (400).

Path Params

accountId

string

required

ID of the account. An account you don't have access to returns 403.

setId

uuid

required

ID of the set.

Body Params

Fields to update.

Request data for creating or updating a set.

name

string | null

Name of the set. Optional; 5-50 characters when present.

description

string | null

Description of the set.

deviceConfiguration

object

Smart Label configuration applied to the devices in the set. Same schema as a device's configuration. If both temperatureMonitoring and humidityMonitoring set a logging interval, both use the lower value; if both set an alert report interval, both use the higher value.

matchCriteria

object

Criteria for matching shipments to the set. A shipment matches when every criterion that is present matches; within a criterion, one matching entry is enough. A set without match criteria matches every shipment. The default set cannot have match criteria.

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to the caller, or the tenant is inactive. Returned by the gateway with an empty body.

200Success

400Invalid request, for example a value out of range, an invalid match criterion, or an invalid deviceConfiguration. Also returned when deviceConfiguration is cleared, or when matchCriteria is sent for the default set.

404Set not found.