> 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 a prompt

PUT https://api.runtype.com/v1/prompts/{id}
Content-Type: application/json

Updates an existing prompt. Only provided fields are updated.

Reference: https://docs.runtype.com/api-reference/runtype-api/prompts/update-a-prompt

## 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) — Prompt TypeID

### Body (application/json)

This endpoint expects an object.

- `model` (string, optional, default: gemini-3.8-flash)
- `name` (string, optional)
- `responseFormat` (enum, optional, default: json)
  - Allowed values: `json`, `markdown`, `text`, `html`, `xml`
- `systemPrompt` (string, optional)
- `text` (string, optional)
- `userPrompt` (string, optional)

## Response

### 200

Updated prompt

- `createdAt` (string, required)
- `estimatedCost` (string, required, nullable)
- `estimatedTokens` (integer, required, nullable)
- `id` (string, required)
- `model` (string, required)
- `name` (string, required)
- `organizationId` (string, required, nullable)
- `responseFormat` (string, required)
- `text` (string, required)
- `updatedAt` (string, required)
- `userId` (string, required)
- `systemPrompt` (string, optional, nullable)
- `userPrompt` (string, optional, nullable)

## Errors

### 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

Prompt 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

### 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, …).

## Examples

**Request**

```json
{
  "responseFormat": "markdown",
  "text": "Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities."
}
```

**Response**

```json
{
  "createdAt": "string",
  "estimatedCost": "string",
  "estimatedTokens": 1,
  "id": "string",
  "model": "string",
  "name": "string",
  "organizationId": "string",
  "responseFormat": "string",
  "text": "string",
  "updatedAt": "string",
  "userId": "string",
  "systemPrompt": "string",
  "userPrompt": "string"
}
```

**SDK Code**

```python Update Prompt
import requests

url = "https://api.runtype.com/v1/prompts/id"

payload = {
    "responseFormat": "markdown",
    "text": "Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Update Prompt
const url = 'https://api.runtype.com/v1/prompts/id';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"responseFormat":"markdown","text":"Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities."}'
};

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

```go Update Prompt
package main

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

func main() {

	url := "https://api.runtype.com/v1/prompts/id"

	payload := strings.NewReader("{\n  \"responseFormat\": \"markdown\",\n  \"text\": \"Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities.\"\n}")

	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 Update Prompt
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/prompts/id")

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 = "{\n  \"responseFormat\": \"markdown\",\n  \"text\": \"Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities.\"\n}"

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

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

HttpResponse<String> response = Unirest.put("https://api.runtype.com/v1/prompts/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"responseFormat\": \"markdown\",\n  \"text\": \"Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities.\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.runtype.com/v1/prompts/id', [
  'body' => '{
  "responseFormat": "markdown",
  "text": "Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities."
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Update Prompt
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/prompts/id");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"responseFormat\": \"markdown\",\n  \"text\": \"Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities.\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Update Prompt
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "responseFormat": "markdown",
  "text": "Enhanced analysis: Review the customer data for {{customer_name}} from {{company_name}}. Focus on: 1) Engagement trends, 2) Purchase patterns, 3) Support interactions, 4) Growth opportunities."
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/prompts/id")! 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()
```