For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList products
      • POSTCreate product
      • POSTAssemble product from FPO
      • GETGet product details
      • PUTUpdate product
      • DELDelete product
      • POSTAdd capability to product
      • PUTUpdate capability
      • DELRemove capability
      • GETPreview cleanup resources
      • GETGet product configuration summary
      • GETList surfaces
      • POSTCreate surface
      • GETGet surface details
      • PUTUpdate surface
      • DELDelete surface
      • POSTAdd item to surface
      • PUTUpdate surface item
      • DELRemove surface item
      • POSTCreate surface API key
      • DELDelete surface API key
      • GETReveal development surface key
      • GETList schedules for surface
      • POSTCreate schedule for surface
      • GETGet schedule details
      • PUTUpdate schedule
      • DELDelete schedule
      • POSTPause schedule
      • POSTResume schedule
      • POSTRun schedule immediately
Dashboard
LogoLogo
Runtype APIProducts

Update surface item

PUT
/v1/products/:id/surfaces/:surfaceId/items/:itemId
PUT
/v1/products/:id/surfaces/:surfaceId/items/:itemId
$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}

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

Was this page helpful?
Previous

Remove surface item

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
surfaceIdstringRequired
itemIdstringRequired

Request

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

Response

Surface item updated
capabilityIdstring
createdAtstring
displayOrderinteger or null
enabledboolean
endpointSlugstring or null
exposedDescriptionstring or null
exposedNamestring or null
idstring
isEntryPointboolean
surfaceIdstring
configany

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error