---
title: "Update prompt metadata"
method: PATCH
path: "/v1/prompts/{prompt_identifier}"
tags: ["prompts"]
---

# Update prompt metadata

`PATCH /v1/prompts/{prompt_identifier}`

Update a prompt's description and metadata by identifier.

## Path parameters

- `prompt_identifier` string, required — The identifier of the prompt, i.e. name or ID.

## Request body

- PatchPromptRequestBody — Fields to update on a prompt. Omit a field to leave it unchanged.
  - `description` string, nullable — New description for the prompt (null clears the description)
  - `metadata` object — New metadata object for the prompt (replaces the existing metadata as a whole)

## Response `200`

The updated prompt

- PatchPromptResponseBody
  - `data` Prompt, required
    - `name` string, required
    - `description` string, nullable
    - `source_prompt_id` string, nullable
    - `metadata` object, nullable
    - `id` string, required

## Other responses

- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

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