operation put api v1 apply sessions parameter.md
Update a session
PUT /api/v1/apply/sessions/{session}
Updates the success_url and cancel_url of a specified session. If either parameter is not provided it will be left unchanged.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- session (string)
The ID of the desired session (e.g.,ias_01FVCHXE7PNQHA1T3S2AXL2QZE).
Body: application/json (object)
cancel_url (string)
The URL the contractor will be directed to if they are ineligible or decide to abandon the insurance application and return to your website.success_url (string)
The URL to which 1099Policy should direct independent contractors when a contractor successfully procures insurance coverage.
Responses
200
Returns the updated session object.
Body: application/json (object)
cancel_url (string)
The URL the contractor will be directed to if they are ineligible or decide to abandon the insurance application and return to your website.created (integer(int64))
expired (boolean)
Indicates whether the insurance application session has expired. If true, the contractor will be redirected to the cancel_url.id (string)
quote (string)
The ID of the quote associated with the insurance application session.step (string)
The step in the insurance application process that the contractor is currently on. The contractor will be redirected to this step when they return to the insurance application. One ofverify_info,application_questions,esignature_document,add_card_details,final_review, orapplication_complete.success_url (string)
The URL to which 1099Policy should direct independent contractors when a contractor successfully procures insurance coverage.url (string)
The URL to the insurance application Session. Redirect customers to this URL to take them to their insurance application. The domain will use apply.1099policy.com.