v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

jobs

Update Job Insurance

This endpoint sets the insurance information for an existing job.

"Insurance company" section: It can be set by ID or by name, but not both. The ID should belong to the existing insurance companies. If the name is used it will be assigned to "Other" (active) insurance company. Set them as not assigned can be done, just sending both(ID & name) null or empty will do it.
dateOfLoss & claimFiledDate should be UTC and in ISO 8601 format (suffixed with 'Z').

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

put/jobs/{jobId}/insurance

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body

_linkstring uri

claimFiledboolean

Indicates if the claim was filed or not.

claimFiledDatestring date-time

Date when the claim was filed.

claimNumberstring

An identifier for the claim.

customInsuranceCompanyNamestring

A name for a custom insurance company

damageLocationstring

A string representing data about the location of the damage.

dateOfLossstring date-time

The date of loss registered for the insurance.

hasPaperworkboolean

Indicates if the insurance has paperwork.

Example request

{
  "insuranceCompany": {
    "insuranceCompanyId": "5587886b-ed58-4a0c-9eda-61f7648b69b5",
    "insuranceCompanyName": "An Insurance Company that is not managed in Account Settings."
  }
}

Response

No Content