imports_post: Create a new import configuration

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

Create a new import configuration

Description

Create a new import configuration

Usage

imports_post(
  name,
  sync_type,
  is_outbound,
  source = NULL,
  destination = NULL,
  schedule = NULL,
  notifications = NULL,
  parent_id = NULL,
  next_run_at = NULL,
  time_zone = NULL,
  hidden = NULL
)

Arguments

name	string required. The name of the import.
sync_type	string required. The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.
is_outbound	boolean required.
source	list optional. A list containing the following elements: remoteHostId integer, credentialId integer, additionalCredentials array, Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.
destination	list optional. A list containing the following elements: remoteHostId integer, credentialId integer, additionalCredentials array, Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.
schedule	list optional. A list containing the following elements: scheduled boolean, If the item is scheduled. scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth scheduledHours array, Hours of the day it is scheduled on. scheduledMinutes array, Minutes of the day it is scheduled on. scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes. scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notifications	list optional. A list containing the following elements: urls array, URLs to receive a POST request at job completion successEmailSubject string, Custom subject line for success e-mail. successEmailBody string, Custom body text for success e-mail, written in Markdown. successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully. successEmailFromName string, Name from which success emails are sent; defaults to "Civis." successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job. failureEmailAddresses array, Addresses to notify by e-mail when the job fails. stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes. successOn boolean, If success email notifications are on. Defaults to user's preferences. failureOn boolean, If failure email notifications are on. Defaults to user's preferences.
parent_id	integer optional. Parent id to trigger this import from
next_run_at	string optional. The time of the next scheduled run.
time_zone	string optional. The time zone of this import.
hidden	boolean optional. The hidden status of the item.

Value

A list containing the following elements:

name	string, The name of the import.
syncType	string, The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.
source	list, A list containing the following elements: remoteHostId integer, credentialId integer, additionalCredentials array, Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id. name string,
destination	list, A list containing the following elements: remoteHostId integer, credentialId integer, additionalCredentials array, Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id. name string,
schedule	list, A list containing the following elements: scheduled boolean, If the item is scheduled. scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth scheduledHours array, Hours of the day it is scheduled on. scheduledMinutes array, Minutes of the day it is scheduled on. scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes. scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notifications	list, A list containing the following elements: urls array, URLs to receive a POST request at job completion successEmailSubject string, Custom subject line for success e-mail. successEmailBody string, Custom body text for success e-mail, written in Markdown. successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully. successEmailFromName string, Name from which success emails are sent; defaults to "Civis." successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job. failureEmailAddresses array, Addresses to notify by e-mail when the job fails. stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes. successOn boolean, If success email notifications are on. Defaults to user's preferences. failureOn boolean, If failure email notifications are on. Defaults to user's preferences.
parentId	integer, Parent id to trigger this import from
id	integer, The ID for the import.
isOutbound	boolean,
jobType	string, The job type of this import.
syncs	array, An array containing the following fields: id integer, source object, destination object, advancedOptions object,
state	string,
createdAt	string,
updatedAt	string,
lastRun	list, A list containing the following elements: id integer, state string, createdAt string, The time that the run was queued. startedAt string, The time that the run started. finishedAt string, The time that the run completed. error string, The error message for this run, if present.
user	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
runningAs	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
nextRunAt	string, The time of the next scheduled run.
timeZone	string, The time zone of this import.
hidden	boolean, The hidden status of the item.
archived	string, The archival status of the requested item(s).
myPermissionLevel	string, Your permission level on the object. One of "read", "write", or "manage".

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