Create set

post

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

Create a new set for an account. Returns 201 with the new set; the Location header holds the set ID.

Path Params

accountId

string

required

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

Query Params

default

boolean

When true, the new set is created as the account's default set.

Body Params

Set to create.

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.

201Set created.

400Invalid request, for example a value out of range, an invalid match criterion, or an invalid deviceConfiguration.