PATCH /rest/v1.0/insurances/sync

This endpoint creates or updates a batch of Company Insurances. Must provide Company ID in the request body.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Request body fields

Name Type Required Description
updates[] Array Yes
updates[].expiration_date String No

Expiration date

updates[].vendor_id Integer No

Vendor ID

updates[].effective_date String No

Effective date

updates[].insurance_sets String No

Insurance Sets

updates[].enable_expired_insurance_notifications Boolean No

Enable/Disable expired insurance notifications

Default value: true

updates[].policy_number String No

Policy number

updates[].status String No

Status

Possible values:

  • "unregistered"
  • "non_compliant_in_progress"
  • "compliant"
  • "undecided"
  • "non_compliant"
  • "expired"
  • "compliant_in_progress"
updates[].company_id Integer Yes

Company ID

updates[].origin_data String No

Origin data

updates[].id Integer No

The ID of the Insurance

updates[].exempt Boolean No

Exempt status

updates[].limit String No

Limit

updates[].name String No

Provider name

updates[].additional_insured String No

Additional Individuals and/or Companies Insured

updates[].notes String No

Notes

updates[].origin_id String No

Origin ID

updates[].insurance_type String No

Insurance type

updates[].division_template String No

Division Template

updates[].info_received Boolean No

Information received (or not)

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.