Skip to main content
PATCH
/
policies
/
{policyId}
Edit Policy
curl --request PATCH \
  --url https://api.example.com/policies/{policyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "invoicingConfig": {
    "frequency": "YEARLY",
    "reconciliationMethod": "INSTANT",
    "timing": "IN_ADVANCE",
    "billAtSignature": "EARLY_PAYMENT",
    "spread": "DYNAMIC",
    "earlyPayment": {
      "amount": 123,
      "unit": "YEAR"
    }
  },
  "periodDuration": {
    "amount": 123,
    "unit": "YEAR"
  },
  "acceptedEmailDomains": [
    "<string>"
  ],
  "acceptedQuoteOptions": {
    "availableConfigs": [
      {
        "tier": "<string>",
        "excess": "<string>",
        "perils": [
          {
            "id": "<string>",
            "required": true,
            "options": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "defaultConfig": {
      "tier": "<string>",
      "excess": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<string>"
        }
      ]
    }
  },
  "maximumNumberOfBikes": 2
}
'
{}

Path Parameters

policyId
string
required

the policy's id

Query Parameters

whenAt
string

Optional: the whenAt datetime

branchId
string

Optional: the branchId

Body

application/json
customFields
object[]

custom fields per product

name
string

Optional: Name of the entity

invoicingConfig
object

the policy's invoicing configuration

periodDuration
object

the policy's period duration

acceptedEmailDomains
string[]

the child policy's customer accepted email domains

acceptedQuoteOptions
object
maximumNumberOfBikes
number

max number of bike

Required range: x >= 1

Response

The response is of type object.