---
title: "Update a prompt"
method: PATCH
path: "/v2/prompts/{prompt_id}"
tags: ["Prompts"]
---

# Update a prompt

`PATCH /v2/prompts/{prompt_id}`

Update a prompt's metadata by its ID. Currently supports updating the
description. The prompt name is immutable after creation; to rename a
prompt, delete it and create a new one (note: this loses version history).

<Note>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>

## Path parameters

- `prompt_id` string, required — A universally unique identifier (base64-encoded opaque string).

## Request body

- UpdatePromptRequest — Prompt update parameters. At least one field must be provided.
  - `description` string, nullable — Updated description for the prompt

## Response `200`

A prompt object

- Prompt — A prompt is a reusable template for LLM interactions. Prompts can be versioned and labeled to track changes over time. Use prompts to standardize how you interact with LLMs across your application.
  - `id` string, required — The prompt ID
  - `name` string, required — The prompt name
  - `description` string, nullable — The prompt description
  - `space_id` string, required — The space ID the prompt belongs to
  - `created_at` string, date-time, required — When the prompt was created
  - `updated_at` string, date-time, required — When the prompt was last updated
  - `created_by_user_id` string, required — The user ID of the user who created the prompt

## Other responses

- `400` — Invalid request
- `401` — Authentication is required
- `403` — Insufficient permissions to access this resource
- `404` — Not found
- `422` — Unprocessable entity
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/arize-ai/apis/arize-rest-api.md) · [All operations](https://skmtc.net/arize-ai/apis/arize-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arize-ai/arize-rest-api/versions/2ce448f1de13/schema)