Admin

Trigger a manual sync on an integration.

A manual sync operation overrides the configured sync schedule for an integration. This operation is typically used during testing phases but may be executed at any time as needed. However, frequent use of manual syncs is not recommended. For questions regarding sync operations, contact Propexo Support.

post/v1/admin/integrations/{integration_id}/manual-sync

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/admin/integrations/{integration_id}/manual-sync
  • Auth: HTTP bearer

Path parameters

integration_idstring required

The ID of the resource.

Request body

sync_config_idstring

The Propexo unique identifier for a sync configuration

models_to_syncV1AdminIntegrationsIntegrationIdManualSyncPostInputModelsToSyncItems[]

A list of the specific models to sync. This will only ingest the models specified during the sync and any relational models. For example, requesting "residents" and "leases" will also query their relational data. This can be used for times when only a limited amount of data would like to be synced. If you'd like this as part of your scheduled syncs, please contact Propexo support.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.