This method is used to void an insurance.
If you are using this endpoint within a loop we highly recommend adding a gap/delay between each iteration.
Method | URI | Headers |
---|---|---|
POST | insurances/{insurance_id}/void |
default |
Field | Type | Description |
---|---|---|
success | Boolean | true or false |
message | String | Message that gives information about the response |
Successful
{
"success": true,
"data": {
"id": 1234567891
},
"message": "Insurance has been voided"
}
Failed
{
"success": false,
"message": "This insurance is not booked"
}
{
"success": false,
"message": "This insurance was already voided"
}
{
"success": false,
"message": "This insurance is already in progress"
}
{
"success": false,
"message": "There was an error in voiding this insurance"
}
{
"success": false,
"message": "Something went wrong. Please contact our support"
}