POST
/
api
/
v1
/
sov
/
update
/
{id}
/
start
Start SOV Update Job
curl --request POST \
  --url https://api.sovfixer.com/api/v1/sov/update/{id}/start \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "extra_data": {},
  "policy_terms": {
    "layer_terms": [
      {
        "name": "<string>",
        "attachment": 123,
        "limit": 123,
        "participation": 123,
        "premium": 123
      }
    ],
    "peril_terms": [
      {
        "group": "<string>",
        "subperil_types": [
          "HU_Wind"
        ],
        "sublimit": 123,
        "min_deductible": 123,
        "max_deductible": 123,
        "blanket_deductible": 123,
        "location_deductible_type": "S",
        "location_deductible": 123,
        "bi_days_deductible": 123
      }
    ],
    "zone_terms": [
      {
        "group": "<string>",
        "subperil_types": [
          "HU_Wind"
        ],
        "sublimit": 123,
        "min_deductible": 123,
        "max_deductible": 123,
        "blanket_deductible": 123,
        "location_deductible_type": "S",
        "location_deductible": 123,
        "bi_days_deductible": 123
      }
    ],
    "excluded_subperil_types": [
      "HU_Wind"
    ]
  },
  "outputter_name": "<string>",
  "output_formats": [
    "json"
  ],
  "metadata": {
    "Timestamp": 123,
    "UserInfo": {
      "UserName": "<string>"
    }
  }
}'
{
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string
required

Body

extra_data
object
required

Extra data associated with the policy.

policy_terms
object

Policy terms to be used by the outputter.

outputter_name
string

Name of the outputter settings to use. This is typically the same as the "Ping Format Name" property of the scrubber.

Minimum length: 1
output_formats
enum<string>[]

If set, specifies the desired output format(s). Defaults to JSON.

metadata
object

Response

message
string
required

API Message.