> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Update surface item

PUT https://api.runtype.com/v1/products/{id}/surfaces/{surfaceId}/items/{itemId}
Content-Type: application/json

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

Reference: https://docs.runtype.com/api-reference/runtype-api/products/update-surface-item

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)
- `surfaceId` (string, required)
- `itemId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `config` (map from string to any, optional, nullable)
- `enabled` (boolean, optional)
- `endpointSlug` (string, optional, nullable)
- `exposedDescription` (string, optional, nullable)
- `exposedName` (string, optional, nullable)
- `isEntryPoint` (boolean, optional)
- `presentation` (V1ProductsIdSurfacesSurfaceIdItemsItemIdPutRequestBodyContentApplicationJsonSchemaPresentation, optional, nullable)

## Response

### 200

Surface item updated

- `capabilityId` (string, required)
- `createdAt` (string, required)
- `displayOrder` (integer, required, nullable)
- `enabled` (boolean, required)
- `endpointSlug` (string, required, nullable)
- `exposedDescription` (string, required, nullable)
- `exposedName` (string, required, nullable)
- `id` (string, required)
- `isEntryPoint` (boolean, required)
- `surfaceId` (string, required)
- `config` (any, optional)
- `warnings` (list of V1ProductsIdSurfacesSurfaceIdItemsItemIdPutResponsesContentApplicationJsonSchemaWarningsItems, optional) — Advisory findings about this binding. Present only when non-empty; never blocks the mutation.

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Product or surface item not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1ProductsIdSurfacesSurfaceIdItemsItemIdPutRequestBodyContentApplicationJsonSchemaPresentation

- `displayLabel` (string, required)
- `displayMode` (enum, required)
  - Allowed values: `chat`, `form`, `document`
- `route` (string, required)
- `displayIcon` (string, optional)
- `displayOrder` (integer, optional, default: 0)
- `formConfig` (V1ProductsIdSurfacesSurfaceIdItemsItemIdPutRequestBodyContentApplicationJsonSchemaPresentationFormConfig, optional)
- `isDefault` (boolean, optional, default: false)
- `visibility` (enum, optional, default: auth-only)
  - Allowed values: `public`, `auth-only`

### V1ProductsIdSurfacesSurfaceIdItemsItemIdPutResponsesContentApplicationJsonSchemaWarningsItems

- `code` (string, required) — Stable advisory code: `APPROVAL_UNANSWERABLE_ON_SURFACE` when an approval-gated agent is bound to a surface with no human to answer the prompt, or `APPROVAL_REPLY_CAPTURE_ON_SURFACE` when the pairing works but the decision is read from the reply the person texts back.
- `message` (string, required)
- `path` (string, required)
- `severity` (enum, required)
  - Allowed values: `warning`, `recommendation`
- `suggestedFix` (string, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1ProductsIdSurfacesSurfaceIdItemsItemIdPutRequestBodyContentApplicationJsonSchemaPresentationFormConfig

- `inputSchemaOverrides` (map from string to any, optional)
- `submitButtonLabel` (string, optional)
- `successMessage` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "capabilityId": "string",
  "createdAt": "string",
  "displayOrder": 1,
  "enabled": true,
  "endpointSlug": "string",
  "exposedDescription": "string",
  "exposedName": "string",
  "id": "string",
  "isEntryPoint": true,
  "surfaceId": "string",
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "severity": "warning",
      "suggestedFix": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/products/id/surfaces/surfaceId/items/itemId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```