API documentation | API docs for agents | OpenAPI 3.1

POST /api/v1/people/import

ark.import_people

Validates and imports driver or dispatcher contacts from parsed CSV rows, linking each row to an exact carrier match.

Availability

Expanded preview

Scopes

people:writecarriers:read

ARK permissions

canCreatePersoncanViewCarriers

Team visibility

Not entity-scoped

Idempotency-Key

Required for this write

Approval

No MCP approval on REST API-token calls

Rate limit

API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired

Required for external write operations. Reuse the same key only for exact retries of the same request body.

min length: 1; max length: 200

Request body

Example request

curl -X POST 'https://arktms.com/api/v1/people/import' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "rows": [
    {
      "carrierName": "<carrierName>",
      "type": "Driver"
    }
  ]
}'

Success response

People import result

Errors

HTTP 400

Invalid request

HTTP 401

Authentication required

HTTP 403

Permission, scope, team, or entitlement denied

HTTP 409

Idempotency conflict or in-progress retry

HTTP 422

Invalid request