[preview] Create a warranty

post

https://api.samsara.com/preview/maintenance/warranties

Creates a warranty 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…

Body Params

Request body for creating a Warranty

baseCoverage

object

CreateWarrantyEntityWarrantyWarrantyCoverageInput object

coverages

array of objects

Additional coverage groups defined on this warranty.

coverages

description

string

Description of the warranty.

durationDays

int64

Warranty length in days. Mutually exclusive with duration in months.

durationMonths

int64

Warranty length in months. Mutually exclusive with duration in days.

engineDurationHours

int64

Warranty length by engine hours since the warranty start.

externalIds

array of objects

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

externalIds

name

string

required

Name of the warranty.

odometerDistanceMeters

int64

Warranty length by distance travelled since the warranty start. Measured in meters.

vendorId

string

ID of the vendor that provides this warranty.

warrantyType

string

Type of warranty, for example manufacturer, extended, other, or unknown.

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

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