ContactObjectImporter APIs
-
Get Pending Import Tasks
Description: Returns a list of import tasks that are still pending or in progress.Usage:
GET api/ContactLists/Importer/Objects/List
Returns:
Returns an array of ImportTask objects.
Examples:
//-- Currently no examples for XML --//
-
Imports New Contacts From GZipped Array
Description: Imports new Contacts to the given contact list. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.Usage:
POST api/ContactLists/Importer/Objects/Import/Compressed/{ListCode}/{PurgeTarget}/{Encoding}
Parameter Type Source Description ListCode Int32 FromUri Unique numerical code that identifies the contact list PurgeTarget Boolean FromUri True if the target list should be purged prior to importing. Encoding String FromUri ASCII or UTF8 Returns:
Returns an ImportTask object containing an identifier for the import and status.
Examples:
//-- Currently no examples for XML --//
-
Imports New Contacts From GZipped Array
Description: Imports new Contacts to the given contact list. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.Usage:
POST api/ContactLists/Importer/Objects/Import/Compressed/{ListCode}/{PurgeTarget}
Parameter Type Source Description ListCode Int32 FromUri Unique numerical code that identifies the contact list PurgeTarget Boolean FromUri True if the target list should be purged prior to importing. Returns:
Returns an ImportTask object containing an identifier for the import and status.
Examples:
//-- Currently no examples for XML --//
-
Imports New Contacts From Array
Description: Imports new Contacts to the given contact list.Usage:
POST api/ContactLists/Importer/Objects/Import/{ListCode}/{PurgeTarget}
Parameter Type Source Description ListCode Int32 FromUri Unique numerical code that identifies the contact list PurgeTarget Boolean FromUri True if the target list should be purged prior to importing. ContactProfile Contact[] FromBody Array of Contact profiles to create Returns:
Returns an ImportTask object containing an identifier for the import and status.
Examples:
//-- Currently no examples for XML --//
-
Cancel Existing Import Task
Description: Cancels an existing import taskUsage:
GET api/ContactLists/Importer/Objects/Cancel/{ImportGuid}
Parameter Type Source Description ImportGuid String FromUri Unique guid identifying the import task to cancel. Returns:
Returns 0 on success.
Examples:
//-- Currently no examples for XML --//
-
Get Import Task Profile
Description: Returns an import task profile and statusUsage:
GET api/ContactLists/Importer/Objects/{ImportGuid}
Parameter Type Source Description ImportGuid String FromUri Unique guid identifying the import task retrieve. Returns:
Returns an ImportTask object containing an identifier for the import and status.
Examples:
//-- Currently no examples for XML --//