# General Translation Platform: カスタムプロンプトを更新する
URL: https://generaltranslation.com/ja/docs/platform/openapi/reference/context-management/update-custom-prompt.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: ID を指定してプロンプトを更新します。省略したフィールドは保存済みの値が維持されます。null を指定すると、nullable なフィールドはクリアされ、マップのエントリは削除されます。それ以外のフィールドに null は指定できません。バッチおよびインポートでは、各項目は自然キーで保存済みの項目と照合されます。バッチに含まれない保存済みの項目は変更されず、それ以外のデータが削除されることもありません。CSV の空のセルは省略として扱われます。更新後の名前とロケールの組み合わせを持つ別のプロンプトがすでに存在する場合は 409 を返します。org:context:write 権限が必要です。カスタムプロンプトの更新に関する API リファレンスです。

{/* このファイルは Fumadocs によって生成されました。直接編集しないでください。変更するには、生成コマンドを再実行してください。 */}

## Endpoint

`PATCH https://api.gtx.dev/v2/context-groups/{groupId}/custom-prompts/{customPromptId}`

**Operation ID:** `updateContextCustomPrompt`

**Tags:** `Context Management`

**Summary:** Update a custom prompt

Updates a prompt by ID. An absent field keeps its stored value. `null` clears a nullable field or removes a map entry; other fields reject `null`. In batches and imports, items match stored items by natural key, stored items absent from the batch are untouched, and nothing else is deleted. A blank CSV cell counts as absent. Returns 409 if another prompt already has the resulting name and locale. Requires `org:context:write`.

Authentication: required. Send an API key in the `Authorization: Bearer <key>` header when authenticating.

### Parameters

- `groupId` (path, string, required): Context group ID.
- `customPromptId` (path, string, required): Custom prompt ID.
- `gt-api-version` (header, "2025-01-01.v0" | "2025-11-03.v1" | "2026-02-18.v1" | "2026-03-06.v1", optional): API contract version. Defaults to the oldest supported version.

### Request body (required)

Body (`application/json`, object):
- `name` (string)
- `locale` (string | null): Locale the prompt applies to; null applies it to every locale.
- `value` (string)
- `description` (string | null): null clears the description.

### Responses

**200**: Custom prompt updated
Response body (`application/json`, object):
- `committed` (true, required)

**400**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**401**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**403**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**404**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**409**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**413**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**429**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

**500**: Request error
Response body (`application/json`, object):
- `error` (string, required)

Response body (`text/html`, string):

Complete OpenAPI 3.1 specification: https://generaltranslation.com/openapi.yaml

OpenAPI schema: [openapi.json](https://generaltranslation.com/openapi.json)

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.