Amendment
Cancel a policy
Changed onCancels an existing policy
delete/v1/amendment/cancel
Request
- Base URLhttps://partnerapi.withfaye.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Authorizationstring
Bearer token
Request body
Example request
{
"policyCode": "POLICY-123456",
"reason": "Customer requested cancellation"
}Response
The policy has been successfully cancelled.
Example response
{
"policyCode": "POLICY-123456",
"status": "canceled",
"cancelReason": "Customer requested cancellation",
"cancelledAt": "2023-01-01T12:00:00Z"
}Changes
- info
added the new optional
headerrequest parameterAuthorization
- info