Update record | Runtype Documentation

Update fields on an existing record.

AuthorizationBearer

API key or Clerk session token

idstringRequired

This endpoint expects an object.

typestringOptional1-255 characters

namestringOptional1-500 characters

metadatamap from strings to anyOptionalDefaults to {}

messageslist of objects or nullOptional

Updated 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

404

Not Found Error

409

Conflict Error

500

Internal Server Error

$	curl -X PUT https://api.runtype.com/v1/records/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"userId": "user_987654321",
4	"organizationId": "org_123456789",
5	"type": "document",
6	"name": "Project Plan Q3 2024",
7	"metadata": {},
8	"messages": [
9	null
10	],
11	"productSurfaceId": "prod_surface_001",
12	"createdAt": "2024-06-01T09:15:00Z",
13	"updatedAt": "2024-06-10T16:45:00Z",
14	"metadataSchema": {},
15	"metadataLabels": {}
16	}

$	curl -X PUT https://api.runtype.com/v1/records/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"userId": "user_987654321",
4	"organizationId": "org_123456789",
5	"type": "document",
6	"name": "Project Plan Q3 2024",
7	"metadata": {},
8	"messages": [
9	null
10	],
11	"productSurfaceId": "prod_surface_001",
12	"createdAt": "2024-06-01T09:15:00Z",
13	"updatedAt": "2024-06-10T16:45:00Z",
14	"metadataSchema": {},
15	"metadataLabels": {}
16	}