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
      • POSTCreate product
      • PUTUpdate product
      • POSTAdd capability to product
      • PUTUpdate capability
      • POSTCreate surface
      • PUTUpdate surface
      • POSTAdd item to surface
      • PUTUpdate surface item
      • POSTCreate surface API key
      • POSTCreate schedule for surface
      • PUTUpdate schedule
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: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "surfaceId": "surface-1234",
4  "capabilityId": "capability-5678",
5  "exposedName": "User Profile Widget",
6  "exposedDescription": "Displays user profile information and settings",
7  "endpointSlug": "user-profile-widget",
8  "isEntryPoint": true,
9  "enabled": true,
10  "displayOrder": 1,
11  "createdAt": "2024-06-01T12:00:00Z",
12  "config": null
13}

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

Was this page helpful?
Previous

Create surface API key

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
surfaceIdstringRequired
itemIdstringRequired

Request

This endpoint expects an object.
exposedNamestring or nullOptional<=100 characters
exposedDescriptionstring or nullOptional
endpointSlugstring or nullOptionalformat: "^[a-z0-9-]+$"<=100 characters
isEntryPointbooleanOptional
enabledbooleanOptional
configmap from strings to any or nullOptional
presentationobject or nullOptional

Response

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

Errors

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