Update surface item | Runtype Documentation

Update an existing surface item. Config updates are deep-merged.

AuthorizationBearer

API key or Clerk session token

idstringRequired

surfaceIdstringRequired

itemIdstringRequired

This endpoint expects an object.

configmap from strings to any or nullOptional

enabledbooleanOptional

endpointSlugstring or nullOptionalformat: "^[a-z0-9-]+$"<=100 characters

exposedDescriptionstring or nullOptional

exposedNamestring or nullOptional<=100 characters

isEntryPointbooleanOptional

presentationobject or nullOptional

Surface item updated

capabilityIdstring

createdAtstring

displayOrderinteger or null

enabledboolean

endpointSlugstring or null

exposedDescriptionstring or null

exposedNamestring or null

idstring

isEntryPointboolean

surfaceIdstring

configany

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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

1	{
2	"capabilityId": "cap-9f8b7c6d5e4a3b2c1d0e",
3	"createdAt": "2024-06-10T09:45:00Z",
4	"displayOrder": 2,
5	"enabled": true,
6	"endpointSlug": "user-profile",
7	"exposedDescription": "Surface item for displaying user profile information",
8	"exposedName": "User Profile",
9	"id": "item-1234567890abcdef",
10	"isEntryPoint": false,
11	"surfaceId": "surface-0987654321fedcba"
12	}