Every endpoint in Warranty: 29 operations across 17 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Warranty
GET/api/warranty
List warranties, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/warranty
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/warranty/{id}
Read one warranty in full
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/warranty
Create a warranty
Body
| Field | Type | Required | Notes |
|---|---|---|---|
status | string | Optional | one of active, claimed, void |
itemId | string (uuid) | Required | None |
serialId | string (uuid) | Optional | None |
serial | string | Optional | at most 120 characters |
quantity | integer | Optional | 1 or more |
customerId | string (uuid) | Optional | None |
sourceDocumentId | string (uuid) | Optional | None |
invoiceNumber | string | Optional | at most 60 characters |
invoiceDate | one of several | Optional | None |
startsOn | one of several | Required | None |
endsOn | one of several | Optional | None |
termValue | integer | Required | 1 or more |
termUnit | string | Required | one of day, week, month, year |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X POST https://app.jaicrm.ai/api/warranty
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"status": "active",
"itemId": "…",
"serialId": "…",
"serial": "…"
}'PATCH/api/warranty/{id}
Change a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
status | string | Optional | one of active, claimed, void |
itemId | string (uuid) | Optional | None |
serialId | string (uuid) | Optional | None |
serial | string | Optional | at most 120 characters |
quantity | integer | Optional | 1 or more |
customerId | string (uuid) | Optional | None |
sourceDocumentId | string (uuid) | Optional | None |
invoiceNumber | string | Optional | at most 60 characters |
invoiceDate | one of several | Optional | None |
startsOn | one of several | Optional | None |
endsOn | one of several | Optional | None |
termValue | integer | Optional | 1 or more |
termUnit | string | Optional | one of day, week, month, year |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X PATCH https://app.jaicrm.ai/api/warranty/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"status": "active",
"itemId": "…",
"serialId": "…",
"serial": "…"
}'DELETE/api/warranty/{id}
Delete a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/warranty/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Comments
GET/api/warranty/{id}/comments
List the comments for a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/warranty/{id}/comments
Add to the comments of a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/warranty/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/warranty/{id}/comments/{commentId}
Remove from the comments of a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/warranty/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Bulk
POST/api/warranty/bulk
Change several warranties at once
curl -X POST https://app.jaicrm.ai/api/warranty/bulk
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/warranty/bulk/assign
Assign several warranties to somebody at once
curl -X POST https://app.jaicrm.ai/api/warranty/bulk/assign
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/warranty/bulk/delete
Delete several warranties at once
curl -X POST https://app.jaicrm.ai/api/warranty/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'Notes
POST/api/warranty/{id}/notes
Add a note to a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/warranty/RECORD_ID/notes
-H 'Authorization: Bearer YOUR_API_KEY'PATCH/api/warranty/{id}/notes/{noteId}
Change or remove a note on a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/warranty/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/warranty/{id}/notes/{noteId}
Change or remove a note on a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/warranty/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Assignees
POST/api/warranty/{id}/assignees
Put somebody on a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/warranty/RECORD_ID/assignees
-H 'Authorization: Bearer YOUR_API_KEY'DELETE/api/warranty/{id}/assignees/{userId}
Take somebody off a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
userId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/warranty/RECORD_ID/assignees/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Related
GET/api/warranty/{id}/related
List the related for a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/related
-H 'Authorization: Bearer YOUR_API_KEY'GET/api/warranty/{id}/related/{module}
List the related for a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
module | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/related/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Export.csv
GET/api/warranty/export.csv
Download warranties as a CSV file
curl -X GET https://app.jaicrm.ai/api/warranty/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'Kanban
GET/api/warranty/kanban
Read warranties arranged as a board
curl -X GET https://app.jaicrm.ai/api/warranty/kanban
-H 'Authorization: Bearer YOUR_API_KEY'Pivot
GET/api/warranty/pivot
Summarise warranties as a pivot table
curl -X GET https://app.jaicrm.ai/api/warranty/pivot
-H 'Authorization: Bearer YOUR_API_KEY'Import
POST/api/warranty/import
Import warranties from a CSV file
curl -X POST https://app.jaicrm.ai/api/warranty/import
-H 'Authorization: Bearer YOUR_API_KEY'Similar
GET/api/warranty/{id}/similar
Find warranties that look like duplicates of this one
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/similar
-H 'Authorization: Bearer YOUR_API_KEY'Dependencies
GET/api/warranty/{id}/dependencies
List what would break if a warranty were deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'Timeline
GET/api/warranty/{id}/timeline
Read everything that has happened to a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/timeline
-H 'Authorization: Bearer YOUR_API_KEY'Email check
GET/api/warranty/{id}/email-check
List the email check for a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/RECORD_ID/email-check
-H 'Authorization: Bearer YOUR_API_KEY'POST/api/warranty/{id}/email
Send an email about a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/warranty/RECORD_ID/email
-H 'Authorization: Bearer YOUR_API_KEY'Expiring
GET/api/warranty/expiring
List the expiring for a warranty
curl -X GET https://app.jaicrm.ai/api/warranty/expiring
-H 'Authorization: Bearer YOUR_API_KEY'For customer
GET/api/warranty/for-customer/{id}
List the for customer for a warranty
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/warranty/for-customer/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.