ACacculynx
jobs

Update Job Insurance

Changed on

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

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/insurance
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body

customInsuranceCompanyNamestring

A job can have an Insurance Company that is not from the list managed in Account Settings. In this case, insuranceCompany will be null.

damagelocationstring

Where the damage is located.

dateOfLossstring

The date the damage occurred in UTC.

claimFiledboolean

Has the claim been filed? Must be true if claimFiledDate is populated.

claimFiledDatestring

The date the claim was filed in UTC.

claimNumberstring

The identifier of the insurance claim given by the insurance company.

hasPaperworkboolean

Is the paperwork for this job collected?

Example request

{
  "insuranceCompany": {
    "insuranceCompanyId": "5587886b-ed58-4a0c-9eda-61f7648b69b5",
    "insuranceCompanyName": "An Insurance Company that is not managed in Account Settings."
  },
  "customInsuranceCompanyName": "An Insurance Company that is not managed in Account Settings.",
  "damagelocation": "Near the chimney.",
  "dateOfLoss": "2020-07-23T16:56:27Z",
  "claimFiledDate": "2020-07-23T16:56:27Z",
  "claimNumber": "123abc",
  "hasPaperwork": true
}

Response

No Content

Changes

  • 443924b00f43Revision changes
    • breaking

      the /// request property type changed from no type to object

    • warning

      removed subschema #2 from the /// request property allOf list

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////