Import customers via CSV

Understanding how to use FeatureOS API to build custom integrations.

Introduction

This endpoint allows you to send us a CSV file to parse and import customers.

The maximum number of customers that you can import is 2000 per request. If your CSV file contains more than 2000 rows, only the first 2000 will be imported.

Please download and modify the sample CSV file to match your data.

POST https://api.featureos.app/api/v3/customers/import

curl -X POST 'https://api.featureos.app/api/v3/customers/import' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/customers/import', {
  method: 'POST',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.featureos.app/api/v3/customers/import',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
Authorization	-	Generate a unique JWT token specific to a user.

Body Parameters

Parameter	Required	Format	Description
csv_file	true	File	CSV file to be imported. Follow the same format as the sample CSV file.

Sample Response

{
  "message": "Customer import has started! You will receive an email once processing is complete.",
  "status": 200,
  "success": true
}

Once the import is complete, you will receive an email with the results. If you have any questions, please contact us at [email protected]