post

/v1/policies/{id}/start

Start an existing policy early.

This creates an extension to the policy to cover the amount of time between the new start time and originally scheduled start time. Use this endpoint when a transaction begins earlier than originally scheduled. A policy can be started early only if it is approved and bound.

Authorization

bearer

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
start_time
string

The new start time of the policy.

2 validations + required

Responses

OK

Schema
object
$schema: http://json-schema.org/draft-04/schema#
id
integer
4 validations
partner_transaction_id
string
1 validation
quote_id
integer
4 validations + required
bind_time
string
2 validations
custom_fields
object
status
string
1 validation
approval_status
string
1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
bearer_token