POST/deals/import/

Bulk deals import

You can import your deals from CSV files using REST API. The CSV file requires the usage of standardized attribute names for the header row, or you can use column mapping to map your custom column names. You can check the progress of your import with a GET request.

Maximum file size: 200MB

Example CSV file: example_deals_import.csv that should be added within Content-Type: multipart/form-data header

Parameters

Parameter	Description
separator	Allows to choose separator type in CSV file during import. Available options: comma (default), tab, semicolon. Example usage: ?separator=semicolon

Attributes	Type	Required	Description
input_file	file	yes	A valid CSV file
column_mapping	json	no	Optional parameter to map CSV column names to different field names during import. Example: {"Deal Number": "Deal Id", "Deal Title": "Name"}

Request

CURL

 curl --location --request POST 'https://<your_app_subdomain>.user.com/api/public/deals/import/' \
--header "Authorization: Token <your_64_char_api_key>" \
--header 'Accept: */*; version=2"' \
--form 'input_file=@"path/to/file.csv"'

JavaScript

var data = new FormData();
data.append("input_file", fileInput.files[0], "importscsv.csv");
 
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/deals/import/");
xhr.setRequestHeader("Authorization", "Token <your_64_char_api_key>g");
xhr.setRequestHeader("Accept", "*/*; version=2\"");

xhr.send(data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<your_app_subdomain>.user.com/api/public/deals/import/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('input_file'=> new CURLFILE('path/to/file.csv"')),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Token <your_64_char_api_key>g',
    'Accept: */*; version=2"'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

import requests

url = "https://<your_app_subdomain>.user.com/api/public/deals/import/"

payload={}
files=[
  ('input_file',('importscsv.csv',open('path/to/file.csv"','rb'),'text/csv'))
]
headers = {
  'Authorization': 'Token <your_64_char_api_key>g',
  'Accept': '*/*; version=2"'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Response

{
    "success": true,
    "data": {
        "import_id": "be027cd9-fa1b-4707-83fa-dbd8ad2cee62"
    }
}