RevKeen Docs
Api reference

Create an import

Create a bulk data import job. The import is processed asynchronously. Poll GET /v2/imports/:id for progress and errors.

Related endpoints

  • GET /imports/{id} — Get import status

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

POST
/imports

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Request Body

application/json

Import configuration

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.revkeen.com/v2/imports" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "resource_type": "customers",    "file_url": "https://example.com",    "column_mapping": {},    "on_duplicate": "skip"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object": "import",
    "status": "pending",
    "resource_type": "customers",
    "total_rows": 0,
    "processed_rows": 0,
    "success_count": 0,
    "error_count": 0,
    "errors": [
      {
        "row": 0,
        "field": "string",
        "message": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
Edit on GitHub