Update record | Runtype Documentation

Update fields on an existing record.

AuthorizationBearer

API key or Clerk session token

idstringRequired

This endpoint expects an object.

messageslist of objects or nullOptional

metadatamap from strings to anyOptionalDefaults to {}

namestringOptional1-500 characters

typestringOptional1-255 characters

Updated record

createdAtstring

idstring

messageslist of any or null

metadatamap from strings to any

namestring

organizationIdstring or null

productSurfaceIdstring or null

typestring

updatedAtstring

userIdstring

metadataLabelsmap from strings to strings

metadataSchemaobject

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: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"createdAt": "2024-06-01T12:00:00Z",
3	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4	"messages": [
5	null
6	],
7	"metadata": {},
8	"name": "Customer Support Ticket #12345",
9	"organizationId": "org_987654321",
10	"productSurfaceId": "prod_surface_001",
11	"type": "support_ticket",
12	"updatedAt": "2024-06-02T08:30:00Z",
13	"userId": "user_123456789",
14	"metadataLabels": {},
15	"metadataSchema": {
16	"keys": [
17	"priority",
18	"category",
19	"status"
20	]
21	}
22	}

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

1	{
2	"createdAt": "2024-06-01T12:00:00Z",
3	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4	"messages": [
5	null
6	],
7	"metadata": {},
8	"name": "Customer Support Ticket #12345",
9	"organizationId": "org_987654321",
10	"productSurfaceId": "prod_surface_001",
11	"type": "support_ticket",
12	"updatedAt": "2024-06-02T08:30:00Z",
13	"userId": "user_123456789",
14	"metadataLabels": {},
15	"metadataSchema": {
16	"keys": [
17	"priority",
18	"category",
19	"status"
20	]
21	}
22	}