Skip to content
Docs
Select language:English

/api/v1/warranties/{id} (PATCH)

PATCH
/api/v1/warranties/{id}
curl --request PATCH \
  --url https://example.com/api/v1/warranties/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "manufacturer", "provider": "example", "startsOn": "2026-04-15", "endsOn": "2026-04-15", "termMonths": 1, "lifetime": true, "leadDays": 1, "claimContact": "example", "registered": true, "registrationDeadline": "2026-04-15" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
kind
string
Allowed values: manufacturer extended store credit_card insurance
provider
Any of:
string
>= 1 characters <= 120 characters
startsOn
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
endsOn
Any of:
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
termMonths
Any of:
integer
>= 1 <= 600
lifetime
boolean
leadDays
integer
<= 365
claimContact
Any of:
string
>= 1 characters <= 300 characters
registered
boolean
registrationDeadline
Any of:
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: manufacturer extended store credit_card insurance
provider
required
string | null
startsOn
required
string
endsOn
required
string | null
termMonths
required
number | null
lifetime
required
boolean
effectiveEndsOn
required
string | null
leadDays
required
number
claimContact
required
string | null
registered
required
boolean
registrationDeadline
required
string | null
state
required
string
Allowed values: active expiring ended
documents
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
role
required
string
sort
required
number
file
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
sha256
required
string
bytes
required
number
mime
required
string
class
required
string
hasGps
required
boolean
width
required
number | null
height
required
number | null
derivativeState
required
string
thumbUrl
required
string | null
displayUrl
required
string | null
deduplicatedFrom
string
url
required
string | null
subject
required
Any of:
object
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdBy
required
object
displayName
required
string
rowVersion
required
number
rowVersion
required
number
createdBy
required
object
displayName
required
string
Example
{
  "kind": "manufacturer",
  "state": "active",
  "documents": [
    {
      "subject": {
        "location": true
      }
    }
  ]
}