Beta APIs

[beta] Update an asset's status

Moves an asset into another status. A comment is required when the status being entered requires one on entry, or the status being left requires one on exit.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Assets under the Assets category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

patch/maintenance/asset-statuses

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

idstring required

Unique identifier for the AssetStatus record.

Request body

commentstring

Note on the most recent status change. On update, required when the status being entered requires a comment on entry, or the status being left requires a comment on exit.

statusUuidstring

Stable ID of the status the asset is in. On update, the status to move the asset into.

Example request

{
  "comment": "12345",
  "statusUuid": "12345"
}

Response

OK response.

Example response

{
  "data": {
    "asset": {
      "id": "281474976710656"
    },
    "comment": "12345",
    "lastChangedBy": {
      "actorId": "12345",
      "actorType": "unknown"
    },
    "status": {
      "category": "unknown",
      "name": "12345",
      "statusUuid": "12345"
    },
    "statusSinceTime": "2019-06-13T19:08:25Z",
    "statusUuid": "12345"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.