Runtype APIProducts

Update surface item

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

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
configanyOptional
warningslist of objectsOptional

Advisory findings about this binding. Present only when non-empty; never blocks the mutation.

Errors

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