ImportDefinition
Defines a reusable pattern of import options. For example, you could create an import definition to upload Subscribers.csv every day into the Customers list to prevent having to re-enter the same parameters every day.
If you import information to a data extension, you must create a data extension object and set the ObjectID property or customer key on the data extension object. You must then set the DestinationObject property to that object. If you are importing to a list, you must create a list object, set an ID property, and set the DestinationObject property to that object. You must specify the ID property for a list. Imports don't currently support the use of ObjectID or CustomerKey when importing to a list.
You can specify what character encoding you wish to use with your imports, but this specification applies to all imports in an account and can only be enabled by your Account Executive.
- To create an ImportDefinition where the destination object is a list, you need the Email | Subscribers | List | Import Subscribers permission.
- To create or update an ImportDefinition where the destination object is a data extension, you need the Email | Subscribers | Data Extension | Import and Manage Data permissions.
- To create or update an ImportDefinition where the destination object is a list and the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | Import Subscribers and View permissions.
| Name | Data Type | Description |
|---|---|---|
AllowErrors | Boolean | Specifies whether an import continues after an error occurs. A value of true permits the import process to continue, and a value of false stops the import process after the first error. |
AutoGenerateDestination | ImportDefinitionAutoGenerateDestination object | Specifies the properties of the destination to be generated automatically during an import. |
Client | ClientID object | Specifies the account ownership and context of an object. |
ControlColumn | String | Specifies the column name in which to find control values as part of an import. Use when the value of ImportDefinitionUpdateType is ColumnBased. |
ControlColumnActions | Array of ImportDefinitionColumnBasedAction objects | Specifies the control column actions to apply to an import. |
ControlColumnDefaultAction | ImportDefinitionColumnBasedActionType | Defines default control column action to take as part of an import definition. Valid values include:
|
CorrelationID | String | Identifies correlation of objects across several requests. |
CreatedDate | DateTime | The date and time when the object was created. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DateFormattingLocale | Locale object | Specifies how dates are formatted in the imported data. |
DeleteFile | Boolean | Indicates whether the call deletes the file used in the import once the process completes. |
Delimiter | String | Specifies the delimiter used as part of an import definition. |
Description | String | Describes and provides information regarding the object. |
DestinationObject | APIObject object | Specifies the destination of an import. |
DestinationType | Int | Not used. |
EndOfLineRepresentation | String | Specifies the line-ending character(s) used in delimited files to be imported. |
FieldMappingType | ImportDefinitionFieldMappingType object | Defines how fields are mapped within an import definition. Valid values include:
|
FieldMaps | Array of FieldMap objects | Specifies the mapping of fields to columns in a file. |
FileSpec | String | Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%). |
FileType | FileType object | Specifies column delimiter of a file. Valid values include:
|
Filter | String | Specifies filter to apply to retrieve. |
HeaderLines | Int | Specifies the number of header lines in the file to ignore. |
ID | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InteractionObjectID | String | Returns associated ID for activities within the asynchronous process of the overall conversation or program. |
Keyword | String | Not used. |
MaxFileAge | Int | Specifies the age of the oldest file to be included in an import definition. Any files older than the maximum age aren't included in the import definition. |
MaxFileAgeScheduleOffset | Int | Specifies an offset in hours to associate with a file age for accomodating timezone differences. This time represents the maximum allowable difference between the scheduled time and the time the import definition actually accesses the file to be imported. |
MaxImportFrequency | Int | Specifies the number of hours to wait before allowing a file to be imported again. This property prevents an import definition run within a program from executing if a specified number of hours have passed since the program began. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
Name | String | Name of the object or property. |
Notification | AsyncResponse object | Specifies the email address to which to send a notification. |
NullRepresentation | String | Defines character used to represent a null value during an import. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
ObjectState | String | Not used. |
Owner | Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey | String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
RetrieveFileTransferLocation | FileTransferLocation object | Specifies the file transfer location to contain the file. |
SourceObject | APIObject object | Specifies source of the import. |
StandardQuotedStrings | Boolean | Specifies whether standard quoted strings are used as part of an import definition. A true value indicates standard quoted strings are used in an import definition. |
SubscriberImportType | ImportDefinitionSubscriberImportType object | Specifies the subscriber import type for an import definition. Possible values are Email and SMS. The default value is Email. |
SubscriptionDefinitionId | String | Identifies subscription to which the import definition is associated. |
UpdateType | ImportDefinitionUpdateType object | Indicates update type associated with an import definition. Valid values include:
|