Sign in
Database tables

Updates the properties of the provided data sync, if the user has the right permissions. Note that if the synced_properties is not provided, the available properties change, then the unavailable ones will automatically be removed.

patch/api/database/data-sync/{data_sync_id}/

Path parameters

data_sync_idinteger required

Updates the data sync related to the provided value.

Request body

OR
OR
OR
OR
OR
OR

Response

idinteger required
typestring required
table_idinteger required

The table where the data is synced into.

database_idstring required
last_syncstring date-time nullable

Timestamp when the table was last synced.

last_errorstring nullable
auto_add_new_propertiesboolean

If enabled and new properties are detected on sync, then they're automatically added. Note that this means all properties will always be added.

delete_unmatched_rowsboolean

If enabled, rows that are no longer present in the source are deleted from the synced table on every sync. If disabled, those rows are kept and reused if the matching source row reappears.

two_way_syncboolean

If enabled, then it's possible to make changes to the synced table. They will automatically be synced with the source data. Note that this is only possible if the data sync type has a two-way sync strategy.

Changes

Changed in 1 of the 6 revisions of this API.1

  • f3396317d9321See the full diff
    • ●

      added the new ERROR_DATA_SYNC_CREDENTIAL_REQUIRED enum value to the error response property for the response status 400

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog