imports_put_syncs: Update a sync

In civis: R Client for the 'Civis Platform API'

Update a sync

Description

Update a sync

Usage

imports_put_syncs(id, sync_id, source, destination, advanced_options = NULL)

Arguments

id	integer required. The ID of the import to fetch.
sync_id	integer required. The ID of the sync to fetch.
source	list required. A list containing the following elements: path string, The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet databaseTable list . A list containing the following elements: schema string, The database schema name. table string, The database table name. useWithoutSchema boolean, This attribute is no longer available; defaults to false but cannot be used. file list . googleWorksheet list . A list containing the following elements: spreadsheet string, The spreadsheet document name. spreadsheetId string, The spreadsheet document id. worksheet string, The worksheet tab name. worksheetId integer, The worksheet tab id. salesforce list . A list containing the following elements: objectName string, This parameter is deprecated
destination	list required. A list containing the following elements: path string, The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named "MySpreadsheet" and a sheet called "Sheet1" this field would be "MySpreadsheet.Sheet1". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet databaseTable list . A list containing the following elements: schema string, The database schema name. table string, The database table name. useWithoutSchema boolean, This attribute is no longer available; defaults to false but cannot be used. googleWorksheet list . A list containing the following elements: spreadsheet string, The spreadsheet document name. spreadsheetId string, The spreadsheet document id. worksheet string, The worksheet tab name. worksheetId integer, The worksheet tab id.
advanced_options	list optional. A list containing the following elements: maxErrors integer, For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing. existingTableRows string, For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of "fail", "truncate", "append", or "drop". Defaults to "fail". firstRowIsHeader boolean, For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row. diststyle string, For Auto Imports. The diststyle to use for a Redshift table. distkey string, For Auto Imports. The distkey to use for a Redshift table. sortkey1 string, For Auto Imports. The first sortkey to use for a Redshift table. sortkey2 string, For Auto Imports. The second sortkey to use for a Redshift table. columnDelimiter string, For Auto Imports. The column delimiter for the file. Valid arguments are "comma", "tab", and "pipe". If column_delimiter is null or omitted, it will be auto-detected. columnOverrides object, For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden. escaped boolean, For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false. identityColumn string, For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table. lastModifiedColumn string, For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to "Auto-Detect", which will use the first column it finds containing either "modif" or "update" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced. rowChunkSize integer, For DB Syncs. If specified, will split the sync into chunks of this size. wipeDestinationTable boolean, For DB Syncs. If true, will perform a full table refresh. truncateLongLines boolean, For DB Syncs to Redshift. When true, truncates column data to fit the column specification. invalidCharReplacement string, For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character. verifyTableRowCounts boolean, For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync. partitionColumnName string, This parameter is deprecated partitionSchemaName string, This parameter is deprecated partitionTableName string, This parameter is deprecated partitionTablePartitionColumnMinName string, This parameter is deprecated partitionTablePartitionColumnMaxName string, This parameter is deprecated mysqlCatalogMatchesSchema boolean, This attribute is no longer available; defaults to true but cannot be used. chunkingMethod string, This parameter is deprecated exportAction string, For Google Doc Exports. The kind of export action you want to have the export execute. Set to "newsprsht" if you want a new worksheet inside a new spreadsheet. Set to "newwksht" if you want a new worksheet inside an existing spreadsheet. Set to "updatewksht" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to "appendwksht" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to "newsprsht" sqlQuery string, For Google Doc Exports. The SQL query for the export. contactLists string, This parameter is deprecated soqlQuery string, This parameter is deprecated includeDeletedRecords boolean, This parameter is deprecated

Value

A list containing the following elements:

id	integer,
source	list, A list containing the following elements: id integer, The ID of the table or file, if available. path string, The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet databaseTable list . A list containing the following elements: schema string, The database schema name. table string, The database table name. useWithoutSchema boolean, This attribute is no longer available; defaults to false but cannot be used. file list . A list containing the following elements: id integer, The file id. googleWorksheet list . A list containing the following elements: spreadsheet string, The spreadsheet document name. spreadsheetId string, The spreadsheet document id. worksheet string, The worksheet tab name. worksheetId integer, The worksheet tab id. salesforce list . A list containing the following elements: objectName string, This parameter is deprecated
destination	list, A list containing the following elements: path string, The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named "MySpreadsheet" and a sheet called "Sheet1" this field would be "MySpreadsheet.Sheet1". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet databaseTable list . A list containing the following elements: schema string, The database schema name. table string, The database table name. useWithoutSchema boolean, This attribute is no longer available; defaults to false but cannot be used. googleWorksheet list . A list containing the following elements: spreadsheet string, The spreadsheet document name. spreadsheetId string, The spreadsheet document id. worksheet string, The worksheet tab name. worksheetId integer, The worksheet tab id.
advancedOptions	list, A list containing the following elements: maxErrors integer, For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing. existingTableRows string, For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of "fail", "truncate", "append", or "drop". Defaults to "fail". firstRowIsHeader boolean, For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row. diststyle string, For Auto Imports. The diststyle to use for a Redshift table. distkey string, For Auto Imports. The distkey to use for a Redshift table. sortkey1 string, For Auto Imports. The first sortkey to use for a Redshift table. sortkey2 string, For Auto Imports. The second sortkey to use for a Redshift table. columnDelimiter string, For Auto Imports. The column delimiter for the file. Valid arguments are "comma", "tab", and "pipe". If column_delimiter is null or omitted, it will be auto-detected. columnOverrides object, For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden. escaped boolean, For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false. identityColumn string, For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table. lastModifiedColumn string, For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to "Auto-Detect", which will use the first column it finds containing either "modif" or "update" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced. rowChunkSize integer, For DB Syncs. If specified, will split the sync into chunks of this size. wipeDestinationTable boolean, For DB Syncs. If true, will perform a full table refresh. truncateLongLines boolean, For DB Syncs to Redshift. When true, truncates column data to fit the column specification. invalidCharReplacement string, For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character. verifyTableRowCounts boolean, For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync. partitionColumnName string, This parameter is deprecated partitionSchemaName string, This parameter is deprecated partitionTableName string, This parameter is deprecated partitionTablePartitionColumnMinName string, This parameter is deprecated partitionTablePartitionColumnMaxName string, This parameter is deprecated mysqlCatalogMatchesSchema boolean, This attribute is no longer available; defaults to true but cannot be used. chunkingMethod string, This parameter is deprecated exportAction string, For Google Doc Exports. The kind of export action you want to have the export execute. Set to "newsprsht" if you want a new worksheet inside a new spreadsheet. Set to "newwksht" if you want a new worksheet inside an existing spreadsheet. Set to "updatewksht" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to "appendwksht" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to "newsprsht" sqlQuery string, For Google Doc Exports. The SQL query for the export. contactLists string, This parameter is deprecated soqlQuery string, This parameter is deprecated includeDeletedRecords boolean, This parameter is deprecated

civis documentation built on Aug. 30, 2025, 1:08 a.m.