Import Customers from CSV

5min

Imports customers from CSV, if requesting manager has access permissions to it.
URL: /api/v1/customers/import_from_csv/
Method: POST
Content-Type:
Required Content-Type is multipart/form-data with the following single key-value pair:
Key: file
Value: {csv file from which to import}
Possible CSV Headers:
email
first_name
last_name
company_name
phone
reference
address
postcode
state
city
country
Data Example:
Text
|
email,first_name,last_name,company_name,phone,reference,address,postcode,state,city,country
example1@email.com,Bruce,Willis,ACME Inc.,,ref_user_1,2645 Black Bear Court,70501,Colorado,Lafayette,US
example2@email.com,Harry,Potter,Hogwarts,+385913334444,ref_user_1,2110 N. Williamston Rd.,70502,Michigan,Williamston,US
email,first_name,last_name,company_name,phone,reference,address,postcode,state,city,country
example1@email.com,Bruce,Willis,ACME Inc.,,ref_user_1,2645 Black Bear Court,70501,Colorado,Lafayette,US
example2@email.com,Harry,Potter,Hogwarts,+385913334444,ref_user_1,2110 N. Williamston Rd.,70502,Michigan,Williamston,US
﻿
Success Response:
Code: 200 OK
Content Examples:
JSON
|
{
    "job_id": 10
}
{
    "job_id": 10
}
﻿
job_id from response can be used to query the import result.

Updated 05 Sep 2023

Did this page help you?

Export Customers

List Customer Accounts

Docs powered by

Archbee

TABLE OF CONTENTS

Content-Type:

Possible CSV Headers:

Data Example:

Success Response: