Update Policy
Update any of the policies with your information. In updating the policy, the id of the policy is required.
Use the endpoint below to update a policy.
PATCH /api/v1/client/policies/{id}
Path param
authorization : *bearer
REQUEST BODY SCHEMA: application/json
Client: **IndividualClientDto**
Name | Description | Required | Type |
---|---|---|---|
firstName | Client's first name | Required | String |
address | Address of the client. >=5 characters | Not Required | string |
city | The name of the city where the client is located | Required | String |
currency | Policy currency code. Refer to /currencies for available currencies. | Required | string |
businessCategory | Business category of the policy. Default is LOCAL . | Not Required | string |
cliendId | Client id. Optional if policy is created by a client. | Not Required | string |
endDate | Policy end date in iso8601 formate | Required | String |
exchangeRate | Currency exchange rate. Defalut: 1 | Not Required | number |
policyType | Type of policy. Enum: "AUTO" "BONDS" "MARINE" "LIFE" | Not Required | String |
premium | Policy premium. >= 1 | Required | number |
Response
Code | Description |
---|---|
200 | Success update |
409 | Unauthorized. |
Example Success Response
Content type
application/json
[
{
"policyNo": "POL-0012",
"currency": "GHC",
"startDate": "2020-01-01T00:00:00.000Z",
"endDate": "2020-12-01T00:00:00.000Z",
"productId": "619c0911b46b424f5f3e470f",
"clientId": "619c0911b46b424f5f3e470f",
"originatingStaffId": "619c0911b46b424f5f3e470f",
"notes": "This is an auto insurance policy. It covers a car.",
"premium": 5000,
"exchangeRate": 1,
"businessType": "NEW_BUSINESS",
"businessCategory": "LOCAL",
"coverType": "COMPREHENSIVE",
"policyType": "AUTO",
"additionalInformation": {},
"assets": [
{
"sumInsured": 100000,
"coverType": "COMPREHENSIVE",
"usage": "PRIVATE",
"description": "lorem ipsum dolor sit amet consectetur adipiscing elit",
"premium": 1000,
"location": "Kampala"
}
]
}
...
]