Help Center
Contact Support
Login to Advocate
Need Help with Advocate?
In this article
Key Changes
Home
Browse Knowledge Base
API Integrations

API Update: New Endpoint for Resetting Sandbox Data and Syncing Configurations

Edited

Status: Live
Effective as-of: 02/20/2025

We have introduced a new endpoint, /operations/reset, designed to enhance the sandbox environment for our clients. This endpoint allows lenders to reset their sandbox data and sync the latest configurations from production.

Key Changes

  • New Endpoint: The /operations/reset endpoint now provides lenders with the ability to reset their data and sync the latest configurations from production as needed.

  • Sandbox Reset: On the day of release, the sandbox environment was completely wiped to sync with the latest production configuration data. As a result, any data previously created in the sandbox is no longer available. The new API only resets data that was creatable/created by the lender and does not affect lookup tables like Asset Types.

    • Collections synced when the user hits /operations/reset:

      • Deals

      • MortgageeClauses

      • Programs

      • RuleConfigurations

  • Consistent IDs Across Environments: Following this update, there is no longer a mismatch in IDs (e.g., Program or Asset IDs) between the sandbox and production environments. All IDs in the sandbox now match their production counterparts, ensuring consistency.

  • Lookup Tables Synchronization: All lookup tables are now synchronized in soft real-time from production to sandbox, with updates generally available in sandbox within seconds. The data stored in these lookup tables remains referentially consistent between production and sandbox.

Please note that the API Documentation has been updated here.