API Service Documentation

Command: leads_csv_import

Retrieves a listing of CRM leads in JSON format

Request

NameTypeRequiredExample
user_idIntegerN1001

Inserting userID if ai_token is not present

config_jsonStringY{...}

Json for configuration. See example & explanation: includes/plugins/api/commands/leads_csv_import.example.json.txt AND includes/plugins/api/commands/leads_csv_import.explanation.json.txt

csv_fileStringY,,,

Full CSV file to be imported

process_nowIntegerN1

Process the entire file now (slower response but no need for followup status checks)

Response

NameTypeExample
process_idInteger1

The Queue processID, if not "process_now"

summaryArray[]

If "process_now" Will Contain an array with the following summary response information: file_upload_count, file_upload_skip_count, file_upload_total, total_count, insert_count, file_upload_insert_count, file_upload_update_count, total_skipped, skip_count, duplicate_count, file_upload_duplicate_count, empty_count, unchanged_count, file_upload_unchanged_count, update_count, file_basename, error_log, view_leads_url