Create record

POST

/v1/records

POST

/v1/records

$ curl -X POST https://api.runtype.com/v1/records \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "John Smith",
>   "type": "customer",
>   "metadata": {
>     "active": true,
>     "company_name": "TechCorp Inc",
>     "customer_name": "John Smith",
>     "customer_type": "enterprise client",
>     "details": "This is a comprehensive quarterly business review covering Q4 performance metrics, detailed analysis of key performance indicators, customer satisfaction scores, revenue growth patterns, and strategic planning initiatives for the upcoming 2024 fiscal year including market expansion opportunities and technology investment priorities.",
>     "features": [
>       "advanced analytics",
>       "24/7 support",
>       "custom integrations"
>     ],
>     "priority_score": 8.5,
>     "product": {
>       "name": "Premium Software Suite",
>       "price": "299.99"
>     },
>     "recipient_name": "Sarah Johnson",
>     "review_type": "detailed",
>     "subject": "Quarterly Business Review",
>     "tone": "friendly yet professional"
>   }
> }'

1 {
2   "createdAt": "string",
3   "id": "string",
4   "messages": [
5     null
6   ],
7   "metadata": {},
8   "name": "string",
9   "organizationId": "string",
10   "ownerId": "string",
11   "productSurfaceId": "string",
12   "schemaValid": true,
13   "type": "string",
14   "updatedAt": "string",
15   "userId": "string",
16   "metadataLabels": {},
17   "metadataSchema": {
18     "keys": [
19       "string"
20     ]
21   },
22   "schemaWarnings": [
23     {
24       "code": "string",
25       "field": "string",
26       "message": "string"
27     }
28   ],
29   "warnings": [
30     {
31       "code": "KEY_RENAMED",
32       "from": "string",
33       "to": "string"
34     }
35   ]
36 }

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

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

namestringRequired1-500 characters

typestringRequired1-255 characters

messageslist of objects or nullOptional

metadatamap from strings to anyOptionalDefaults to {}

ownerIdstring or nullOptional1-255 characters

Owner key for this record, stored in the indexed owner_id column and filterable via ?ownerId=. Overrides a nested metadata.ownerId. Null means no owner.

Response

Created record

createdAtstring

idstring

messageslist of any or null

metadatamap from strings to any

namestring

organizationIdstring or null

ownerIdstring or null

productSurfaceIdstring or null

schemaValidboolean or null

typestring

updatedAtstring

userIdstring

metadataLabelsmap from strings to stringsOptional

metadataSchemaobjectOptional

schemaWarningslist of objectsOptional

warningslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error