Skip to main content

​
Overview

Policy actions allow you to request carrier-side changes to a policy on behalf of your user. Once submitted, Axle will process the request and the policy will be updated once the action is complete. The following operations are currently supported:
OperationDescription
request-primary-lienholderRequest that your organization be added as the primary lienholder on the policy.

​
Executing a Policy Action

Submit a POST /policies/{policyId}/actions request with the desired operation.
Request Sample: cURL
curl --request POST \
  --url https://api.axle.insure/policies/pol_mZj6YGXhQyQnccN97aXbq/actions \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
  --header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
  --data '{
  "operation": "request-primary-lienholder"
}'
A successful response returns the ID of the created policy action.
Response Sample
{
  "success": true,
  "data": {
    "id": "pla_mZj6YGXhQyQnccN97aXbq"
  }
}

​
Error Codes

If the request does not succeed, you may receive a 400 Bad Request or 500 Internal Server Error response.

​
400 Bad Request

errorCodemessageWhen it occurs
policy-action-not-supportedPolicy action <operation> is not supported for this policy.The requested operation is not available for this policy.

​
500 Internal Server Error

errorCodemessageWhen it occurs
defaultOops something went wrong. Please try again later.Default when an unexpected server error occurs. Retrying may succeed.