v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Update Job Insurance Company

This endpoint sets an insurance company to an existing job. 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.

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

put/jobs/{jobId}/insurance/insurance-company

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body

insuranceCompanyIdstring uuid nullable

The insurance company's unique ID is to be set to the job.

insuranceCompanyNamestring nullable

A job can have an insurance company that is not from the list managed in Account Settings. In this case, the 'insuranceCompanyId' should be null. The text will be assigned to the comments field for the 'Other' (active) insurance company.

Example request

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

Response

No Content