[preview] Update a warranty claim

patch

https://api.samsara.com/preview/maintenance/warranty-claims

Updates an existing warranty claim for the organization.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Write Warranties under the Work Orders category when creating or editing an API token. Learn More.

Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should NOT rely on these APIs to build business critical applications

Samsara may change the structure of a preview API's interface without versioning or any notice to API users.
When an endpoint becomes generally available, it will be announced in the API changelog.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

required

Unique identifier for the WarrantyClaim record.

Body Params

Request body for updating a WarrantyClaim

assetId

string

ID of the asset the claim is filed for. Immutable once set.

cause

string

The cause of the 3 Cs - the root cause found.

claimEngineHours

int64

Engine hours at the time of repair.

claimOdometerMeters

int64

Asset odometer reading at the time of repair. Measured in meters.

claimStatus

string

Current status of the claim.

componentInstanceIds

array of strings

IDs of asset component instances covered by this claim.

componentInstanceIds

concern

string

The concern of the 3 Cs - what was reported.

correction

string

The correction of the 3 Cs - the work performed.

externalIds

array of objects

Customer-supplied external identifiers for the warranty claim, interchangeable with id in filters. Only included in the response when includeExternalIds is set.

externalIds

labor

array of objects

Labor being claimed.

labor

linkedWarrantyId

string

ID of the warranty this claim is filed against.

linkedWorkOrderIds

array of strings

IDs of the work orders associated with this claim.

linkedWorkOrderIds

mediaItemIds

array of strings

IDs of media items attached to the claim.

mediaItemIds

otherCost

object

UpdateWarrantyClaimEntityWarrantyClaimMoneyInput object

parts

array of objects

Parts being claimed.

parts

reimbursedAtTime

string

When reimbursement was received.

reimbursements

array of objects

Reimbursement amounts, optionally linked to a work order.

reimbursements

repairCompletedAtTime

string

When the repair was completed.

resolutionAtTime

string

When the claim was resolved.

submittedAtTime

string

When the claim was submitted to the vendor.

warrantyVendorId

string

ID of the vendor handling the claim.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

413Content Too Large response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.