PATCH /rest/v1.0/companies/{company_id}/insurances/sync
This endpoint creates or updates a batch of Company Insurances.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
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:
|
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
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.