Update property time interval

Request

Specify a value that was set for a given time range, or specify no value was set for that range. Existing records overlapping that time range may be split, trimmed, or deleted to accommodate this assertion. This endpoint should only be used for updating past time intervals. To update the current value of a property use the update device endpoint.

Security

ApiKey(Required scopes: devices.update)

Path

nameOrIdstringrequired

Device name or ID. Device names must be URI-encoded if they contain non-URI-safe characters. If a device is named with another device's ID, the device with the matching name will be returned.

Bodyapplication/jsonrequired

projectIdstring

The project ID of the device. Required for multi-project orgs.

keystringrequired

The key of the property. Must be an existing device custom property key for your organization.

valuestring or number or boolean or Array of strings

One of:

The value of the property over the given time range. Omit to specify no value was set for that range.

string

startstring, (date-time)required

Inclusive start of the property's effective time range. Must be in the past.

endstring, (date-time)required

Exclusive end of the property's effective time range. Must be in the past.

Payload

{
  "projectId": "string",
  "key": "string",
  "value": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z"
}

Responses

Success