Beta APIs

[beta] Mark an asset as recovered.

Mark a missing asset as recovered. Provide the recovery status, reason for being missing, and optional additional details.

<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.

post/fleet/assets/device-recovery/{id}/recovered

Request

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

Path parameters

idstring required

The ID of the asset. This can be a Samsara internal ID or an external ID in the format key:value.

Request body

additional_detailsstring

Optional additional details about the recovery.

missing_reason'MISPLACED' | 'STOLEN' | 'NOT_SURE' required

The reason the asset was marked as missing. Valid values: MISPLACED, STOLEN, NOT_SURE

recovery_status'YES' | 'NO' | 'NOT_SURE' required

Whether the asset has been physically recovered. Valid values: YES, NO, NOT_SURE

status'RECOVERED' required

The recovery status to set for the asset. Valid values: RECOVERED

Example request

{
  "additional_details": "Found in warehouse B",
  "missing_reason": "MISPLACED",
  "recovery_status": "YES",
  "status": "RECOVERED"
}

Response

OK response.

Example response

{
  "data": {
    "id": "12345",
    "name": "Trailer-A1234",
    "note": "Asset was last seen at warehouse A",
    "notification_recipients": [
      {
        "email": "jane.doe@example.com",
        "name": "Jane Doe",
        "notification_types": [
          "email"
        ],
        "user_id": 1234
      }
    ],
    "recovery_photos": [
      {
        "start_ms": 1609459200000,
        "status": "EXISTS",
        "url": "https://s3.amazonaws.com/samsara-recovery-photos/example.jpg",
        "url_expires_at_ms": 1609462800000
      }
    ],
    "update_source": "dashboard",
    "updated_at_ms": 1609459200000,
    "updated_by_user_id": 1234
  }
}

Changes

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