Create record | Runtype Documentation

Create a new record with metadata. Returns 409 if a record with the same type and name already exists in the tenant.

AuthorizationBearer

API key or Clerk session token

This endpoint expects an object.

typestringRequired1-255 characters

namestringRequired1-500 characters

metadatamap from strings to anyOptionalDefaults to {}

messageslist of objects or nullOptional

Created record

idstring

userIdstring

organizationIdstring or null

typestring

namestring

metadatamap from strings to any

messageslist of any or null

productSurfaceIdstring or null

createdAtstring

updatedAtstring

metadataSchemamap from strings to any

metadataLabelsmap from strings to any

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/records \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"type": "document",
>	"name": "Project Plan Q3"
>	}'

1	{
2	"id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2b3e4f5678",
3	"userId": "user_987654321",
4	"organizationId": "org_123456789",
5	"type": "document",
6	"name": "Project Plan Q3",
7	"metadata": {},
8	"messages": [
9	null
10	],
11	"productSurfaceId": "prod_surface_001",
12	"createdAt": "2024-06-10T09:15:30Z",
13	"updatedAt": "2024-06-10T09:15:30Z",
14	"metadataSchema": {},
15	"metadataLabels": {}
16	}

$	curl -X POST https://api.runtype.com/v1/records \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"type": "document",
>	"name": "Project Plan Q3"
>	}'

1	{
2	"id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2b3e4f5678",
3	"userId": "user_987654321",
4	"organizationId": "org_123456789",
5	"type": "document",
6	"name": "Project Plan Q3",
7	"metadata": {},
8	"messages": [
9	null
10	],
11	"productSurfaceId": "prod_surface_001",
12	"createdAt": "2024-06-10T09:15:30Z",
13	"updatedAt": "2024-06-10T09:15:30Z",
14	"metadataSchema": {},
15	"metadataLabels": {}
16	}