Runtype APIProducts

Update surface

Update an existing surface. Supports partial updates with shallow-merge for behavior.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
surfaceIdstringRequired

Request

This endpoint expects an object.
behavioranyOptional
configanyOptional
environmentenumOptional
Allowed values:
inboundmap from strings to anyOptional
namestringOptional1-255 characters
outboundmap from strings to anyOptional
statusenumOptional
Allowed values:

Response

Surface updated
createdAtstring
endpointstring or null

Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, …). Clients should use this instead of constructing the URL themselves.

environmentstring
idstring
namestring
productIdstring
statusstring
typestring
updatedAtstring
behaviorany
inboundany
outboundany

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error