Import customers from a CSV file

customer.import

Creates customers for one Product from a CSV file of at most 1,000 rows with the columns kind, display_name and country, the fields customer.create takes for the legal entity. A dry run comes first and is the default: it judges every row and creates nothing. With commit true every row becomes a customer as customer.create makes one, with its entity pending verification and pending access to the Product, in one operation; a file with any refused row creates none. Both answer a verdict file with one row per data row. The file carries no money: an amount, balance or account column refuses it, since accounts open and money moves only through the Product's program.

POST /v1/customers/import

Principal api_key. Idempotency required. Environment either.

Input

Output

Request sample

curl

curl --request POST 'https://hyperscale0.ai/v1/customers/import' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header "Idempotency-Key: $(uuidgen)" \
  --header 'Content-Type: application/json' \
  --data-raw '{"productId":"prd_sandbox_example0001","csv":"x"}'

TypeScript SDK

import { createClient } from "@hyperscale0/sdk";

const hs = createClient({
  apiKey: process.env.HYPERSCALE_API_KEY,
  productId: process.env.HYPERSCALE_PRODUCT_ID,
});
const result = await hs.call("customer.import", {
  "productId": "prd_sandbox_example0001",
  "csv": "x"
});

CLI

hyperscale api call customer.import \
  --input '{"productId":"prd_sandbox_example0001","csv":"x"}'

Errors

All operations