Update a policy (skip module validation)

patch

https://sandbox.uk.rootplatform.com/v1/insurance/policies/{policy_id}/skip-module-validation

Update attributes on a policy, bypassing the product module code validation. Note: This endpoint must be enabled for your organization. Contact Root to have it enabled. Until then, requests return a 404. The API key must also hold the policies:update:skip_module_validation permission.

Path Params

policy_id

string

required

The unique identifier of the policy.

Body Params

app_data

object | null

null is allowed. An object containing additional custom data for the policy.

billing_day

integer

Day of the month on which the policy should be billed. Should be between 1 and 31. Billing day cannot be changed once a payment method is assigned to the policy.

package_name

string

The package name, as originally specified in the quote hook

external_reference

string

An optional external identifier for the policy, for example a reference from a legacy or third-party system the policy was migrated from. Omitting this field leaves any existing value unchanged.

sum_assured

integer

The amount, in cents, of the total value insured.

base_premium

integer

The amount, in cents, of the base premium.

monthly_premium

integer

The amount, in cents, of the monthly premium, as written on the policy schedule.

billing_amount

integer

The amount, in cents, billed each billing period.

start_date

date-time

The start date of the policy.

end_date

date-time

The end date of the policy.

module

object

Custom module-specific fields stored against the policy. See product modules for more details.

policy_number

string

A short-hand unique identifier for the policy, referenced in policy documents and displayed on the Root management dashboard. Must be unique within the organisation.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

404Not found