Upload CSV records | Runtype Documentation

Upload and process a CSV file to create records in bulk. Either supply typeColumn to read the type from a column, or typeValue to assign the same constant type to every row (skipping the column lookup). typeValue takes precedence when both are provided.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects a multipart form.

fileany or nullOptional

typeColumnstringOptional

nameColumnstringOptional

typeValuestringOptional<=255 characters

Response

CSV upload result

successboolean

messagestring

createdinteger

errorsinteger

errorDetailslist of strings

recordslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	{
2	"success": true,
3	"message": "CSV file processed successfully with some warnings.",
4	"created": 45,
5	"errors": 2,
6	"errorDetails": [
7	"Row 12: Missing required field 'email'.",
8	"Row 27: Invalid date format in 'signup_date'."
9	],
10	"records": [
11	{
12	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
13	"type": "customer",
14	"name": "Acme Corporation",
15	"metadata": {}
16	}
17	]
18	}

1	{
2	"success": true,
3	"message": "CSV file processed successfully with some warnings.",
4	"created": 45,
5	"errors": 2,
6	"errorDetails": [
7	"Row 12: Missing required field 'email'.",
8	"Row 27: Invalid date format in 'signup_date'."
9	],
10	"records": [
11	{
12	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
13	"type": "customer",
14	"name": "Acme Corporation",
15	"metadata": {}
16	}
17	]
18	}

$	curl -X POST https://api.runtype.com/v1/records/upload-csv \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: multipart/form-data"