User.com REST API Docs # 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_import_deals.csv that should be added within Content-Type: multipart/form-data header
POST /deals/import/
# 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
- JavaScript
- PHP
- Python
curl --location --request POST 'https://<your_app_subdomain>.user.com/api/public/deals/import/' \
--header 'Content-Type: multipart/form-data' \
--header "Authorization: Token <your_64_char_api_key>" \
--header 'Accept: */*; version=2"' \
--form 'input_file=@"path/to/file.csv"'
# Response
{
"success": true,
"data": {
"import_id": "be027cd9-fa1b-4707-83fa-dbd8ad2cee62"
}
}