operation put api v1 policies parameter.md
Update a policy
PUT /api/v1/policies/{policy}
Policies can be switched on and off using the is_active flag.
Use this functionality if you don't have preset policy start and end times.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- policy (string)
The ID of the desired policy (e.g.,pl_WzFRszJhoY).
Body: application/json (object)
- is_active (boolean)
A flag to switch the policy on or off.
Responses
200
Returns the policy object if the update succeeded. Returns an error if update parameters are invalid.
Body: application/json (object)
certificates (object)
created (integer(int64))
effective_date (integer(int64))
A timestamp used to determine the insurance policy start date. Measured in seconds since the Unix epoch. The default effective_date is the next day.expiration_date (integer(int64))
A timestamp used to determine the insurance policy end date. Measured in seconds since the Unix epoch. The default expiration_date is 30 days after the effective_date.id (string)
pdf_url (string)
A URL for the hosted insurance policy PDF, which contractors can view.quote (string)
The ID of the quote used to create the policy.status ()
One ofactive,cancelled, orexpired.