Contact_Import_Delayed

Contact_Import_Delayed( string keyarray contactsstringsourcestring callbackUrlstring jobIdint chunkNumoptionalstruct optionalParameters)
 

Note: When using one of the API wrappers, you do not need to pass the API key. The wrapper will pass the key for you, your first parameter should be the second parameter in the signature.

Description

Import a collection of contacts into a set of lists and groups asynchronously. This call is a companion to Contact_Import, but it's designed to integrate with webapps - using this call, you can get very fast responses from the API so that your webapp can continue its user-flow without waiting for all of your contacts to be verified and imported. We'll send the return values to use via a POST to your callbackUrl which will include the jobId, chunkNum and a data struct containing the results of the import following the same format as the return value of Contact_Import.

Parameters

  string key Your API key - used to authenticate your account
  array contacts Array of contact_hash items, as explained above
contacts is an array of structs, where each struct can contain:
- email => value
- customFieldToken => value
- customFieldId => value

Each contact_hash must have a valid email

Ex:
contacts = [
{"email":"mail2@lynch2.com", "first_name":"Test", "last_name":"User"},
{"email":"support@mail2.com", 1:"Support", 2:"User"}
];
  string source A short description of the source of your contacts
  string callbackUrl A URL endpoint for the results of the import to be POSTed to
  string jobId A Job ID used to match up the import in your webapp
  int chunkNum An Import Chunk number used to match up in your webapp - use this to keep track of what chunks have been processed, they may not be handled in order
optional bool triggerWorkflows Triggers all workflows for which the contact is eligible - defaults to false
optional struct optionalParameters A struct of optional parameters, see below for valid keys

optionalParameters can include:

array listIds Import these contacts into all of the specified lists
array groupIds Import these contacts into all of the specified lists
bool activateDeleted If this contact was already deleted, reactivate them - defaults to true
bool updateCustomFields If this contact already exists, replace custom field values with values provided - defaults to false

Return

bool  

Still need help? Contact Us Contact Us