Skip to main content
POST
Request Policy Update

Authorizations

x-client-secret
string
header
required

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.

Headers

x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

x-destination-client-id
string

The client ID of the destination client. This is optional and only used by platform clients. See the Axle for Platforms guide for more information.

Path Parameters

policyId
string
required

The unique ID for the policy to execute the action on.

Body

application/json
operation
enum<string>
required

The policy update operation to execute.

Available options:
update-third-party
input
object

Details for the insurance carrier, overriding your policy update configuration. An insurance carrier may require a field or not apply it; see Input.

Response

The policy update was successfully created and is being processed.

success
boolean

Indicates whether the operation was performed successfully.

Example:

true

data
object