Update Zone Terms
curl --request PATCH \
--url https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"bi_days_deductible": 1073741823,
"bi_location_deductible": "<string>",
"bi_min_deductible": "<string>",
"bi_sublimit": "<string>",
"included": true,
"is_deductible_combined": true,
"is_sublimit_combined": true,
"max_deductible": "<string>",
"min_deductible": "<string>",
"pd_building_location_deductible": "<string>",
"pd_contents_location_deductible": "<string>",
"pd_min_deductible": "<string>",
"pd_sublimit": "<string>",
"per_location_deductible": "<string>",
"peril_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sublimit": "<string>"
}
'import requests
url = "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}"
payload = {
"bi_days_deductible": 1073741823,
"bi_location_deductible": "<string>",
"bi_min_deductible": "<string>",
"bi_sublimit": "<string>",
"included": True,
"is_deductible_combined": True,
"is_sublimit_combined": True,
"max_deductible": "<string>",
"min_deductible": "<string>",
"pd_building_location_deductible": "<string>",
"pd_contents_location_deductible": "<string>",
"pd_min_deductible": "<string>",
"pd_sublimit": "<string>",
"per_location_deductible": "<string>",
"peril_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sublimit": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bi_days_deductible: 1073741823,
bi_location_deductible: '<string>',
bi_min_deductible: '<string>',
bi_sublimit: '<string>',
included: true,
is_deductible_combined: true,
is_sublimit_combined: true,
max_deductible: '<string>',
min_deductible: '<string>',
pd_building_location_deductible: '<string>',
pd_contents_location_deductible: '<string>',
pd_min_deductible: '<string>',
pd_sublimit: '<string>',
per_location_deductible: '<string>',
peril_group: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sublimit: '<string>'
})
};
fetch('https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'bi_days_deductible' => 1073741823,
'bi_location_deductible' => '<string>',
'bi_min_deductible' => '<string>',
'bi_sublimit' => '<string>',
'included' => true,
'is_deductible_combined' => true,
'is_sublimit_combined' => true,
'max_deductible' => '<string>',
'min_deductible' => '<string>',
'pd_building_location_deductible' => '<string>',
'pd_contents_location_deductible' => '<string>',
'pd_min_deductible' => '<string>',
'pd_sublimit' => '<string>',
'per_location_deductible' => '<string>',
'peril_group' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sublimit' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}"
payload := strings.NewReader("{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "019dd58e-eb2a-7958-8070-570003e4ee60",
"zone": "Tier1",
"peril_class": "HU",
"included": true,
"sublimit": 3000000,
"per_location_deductible": 10,
"per_location_deductible_type": "S",
"per_location_deductible_format": "P",
"min_deductible": null,
"max_deductible": null,
"deductible_type": null,
"tiv": null,
"location_count": 0,
"bi_days_deductible": 5,
"peril_group_uuid": "019dd58e-eb2a-7958-8070-570003e4ee51"
}CAT Modeling
Update Zone Terms
Updates the terms for a single zone (e.g. CA, Tier1, AllOther) within a coverage option’s peril class. peril_group links the zone to the peril group whose subperils it applies to; pass its uuid, or null to clear the association.
PATCH
/
api
/
v1
/
submission
/
{pingid}
/
cat
/
coverage-options
/
{coverage_option_uuid}
/
zones
/
{zone_uuid}
Update Zone Terms
curl --request PATCH \
--url https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"bi_days_deductible": 1073741823,
"bi_location_deductible": "<string>",
"bi_min_deductible": "<string>",
"bi_sublimit": "<string>",
"included": true,
"is_deductible_combined": true,
"is_sublimit_combined": true,
"max_deductible": "<string>",
"min_deductible": "<string>",
"pd_building_location_deductible": "<string>",
"pd_contents_location_deductible": "<string>",
"pd_min_deductible": "<string>",
"pd_sublimit": "<string>",
"per_location_deductible": "<string>",
"peril_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sublimit": "<string>"
}
'import requests
url = "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}"
payload = {
"bi_days_deductible": 1073741823,
"bi_location_deductible": "<string>",
"bi_min_deductible": "<string>",
"bi_sublimit": "<string>",
"included": True,
"is_deductible_combined": True,
"is_sublimit_combined": True,
"max_deductible": "<string>",
"min_deductible": "<string>",
"pd_building_location_deductible": "<string>",
"pd_contents_location_deductible": "<string>",
"pd_min_deductible": "<string>",
"pd_sublimit": "<string>",
"per_location_deductible": "<string>",
"peril_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sublimit": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bi_days_deductible: 1073741823,
bi_location_deductible: '<string>',
bi_min_deductible: '<string>',
bi_sublimit: '<string>',
included: true,
is_deductible_combined: true,
is_sublimit_combined: true,
max_deductible: '<string>',
min_deductible: '<string>',
pd_building_location_deductible: '<string>',
pd_contents_location_deductible: '<string>',
pd_min_deductible: '<string>',
pd_sublimit: '<string>',
per_location_deductible: '<string>',
peril_group: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sublimit: '<string>'
})
};
fetch('https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'bi_days_deductible' => 1073741823,
'bi_location_deductible' => '<string>',
'bi_min_deductible' => '<string>',
'bi_sublimit' => '<string>',
'included' => true,
'is_deductible_combined' => true,
'is_sublimit_combined' => true,
'max_deductible' => '<string>',
'min_deductible' => '<string>',
'pd_building_location_deductible' => '<string>',
'pd_contents_location_deductible' => '<string>',
'pd_min_deductible' => '<string>',
'pd_sublimit' => '<string>',
'per_location_deductible' => '<string>',
'peril_group' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sublimit' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}"
payload := strings.NewReader("{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vision.pingintel.com/api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bi_days_deductible\": 1073741823,\n \"bi_location_deductible\": \"<string>\",\n \"bi_min_deductible\": \"<string>\",\n \"bi_sublimit\": \"<string>\",\n \"included\": true,\n \"is_deductible_combined\": true,\n \"is_sublimit_combined\": true,\n \"max_deductible\": \"<string>\",\n \"min_deductible\": \"<string>\",\n \"pd_building_location_deductible\": \"<string>\",\n \"pd_contents_location_deductible\": \"<string>\",\n \"pd_min_deductible\": \"<string>\",\n \"pd_sublimit\": \"<string>\",\n \"per_location_deductible\": \"<string>\",\n \"peril_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sublimit\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "019dd58e-eb2a-7958-8070-570003e4ee60",
"zone": "Tier1",
"peril_class": "HU",
"included": true,
"sublimit": 3000000,
"per_location_deductible": 10,
"per_location_deductible_type": "S",
"per_location_deductible_format": "P",
"min_deductible": null,
"max_deductible": null,
"deductible_type": null,
"tiv": null,
"location_count": 0,
"bi_days_deductible": 5,
"peril_group_uuid": "019dd58e-eb2a-7958-8070-570003e4ee51"
}Authorizations
Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required range:
0 <= x <= 2147483647Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, , null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, , null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, , null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, , null S- SitedeductibleC- PerunitcoverageCT- CombinedwithtimeelementCB- ApplytopropertydamagePL- Percentofloss
Available options:
S, C, CT, CB, PL, , null UUID of the peril group
Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Response
200 - application/json
Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Number of locations that fall under this zone. Should be calculated on change.
Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, null Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Percent or dollar?
P- PercentageC- Currency
Available options:
P, C, null S- SitedeductibleC- PerunitcoverageCT- CombinedwithtimeelementCB- ApplytopropertydamagePL- Percentofloss
Available options:
S, C, CT, CB, PL, null HU- HuEQ- EqIF- FloodSCS- SevereconvectivestormAOP- AopWF- WildfireTE- TerrorismNC- Noncat
Available options:
HU, EQ, IF, SCS, AOP, WF, TE, NC Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$Total Insured Value for this zone.
Pattern:
^-?\d{0,18}(?:\.\d{0,2})?$UUID of the zone
TriCounty- TricountyTier1- Tier1Tier1 TX-VA- Tier1TxtovaTier1 TX-NC- Tier1TxtoncTier1 MD-ME- Tier1MdtomeTier1 VA-ME- Tier1VatomeTier2- Tier2AK- AkCA- CaCO- CoFL- FlHI- HiOK- OkNewMadrid- NewmadridPacNW- PacnwPR- PrTX- TxInland TX- InlandtexasSFHA- SfhaMFHA- MfhaHigh Hazard- HighhazardAllOther- AllotherUnknown- UnknownCustom1- Custom1Custom2- Custom2Custom3- Custom3Custom4- Custom4
Available options:
TriCounty, Tier1, Tier1 TX-VA, Tier1 TX-NC, Tier1 MD-ME, Tier1 VA-ME, Tier2, AK, CA, CO, FL, HI, OK, NewMadrid, PacNW, PR, TX, Inland TX, SFHA, MFHA, High Hazard, AllOther, Unknown, Custom1, Custom2, Custom3, Custom4, null ⌘I