# General Translation Platform: Update a custom prompt
URL: https://generaltranslation.com/en-GB/docs/platform/openapi/reference/custom-prompts/update-context-custom-prompt.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Updates a prompt by ID. Requires org:context:write.

## Endpoint

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

**Operation ID:** `updateContextCustomPrompt`

**Tags:** `Custom prompts`

**Summary:** Update a custom prompt

Updates a prompt by ID. 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, "2026-10-08.v1", optional): API contract version. Defaults to the oldest supported version.

### Request body (required)

Body (`application/json`, object): 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.
- `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**: The request is malformed or failed validation.
Response body (`application/json`, object):
- `error` (string, required)

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

**401**: Authentication is missing or invalid.
Response body (`application/json`, object):
- `error` (string, required)

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

**403**: The caller is authenticated but not allowed to perform this operation or access the requested resource.
Response body (`application/json`, object):
- `error` (string, required)

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

**404**: The requested resource was not found.
Response body (`application/json`, object):
- `error` (string, required)

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

**409**: Another prompt already has the resulting name and locale.
Response body (`application/json`, object):
- `error` (string, required)

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

**413**: The request, or the data it would return, exceeds a size or item limit.
Response body (`application/json`, object):
- `error` (string, required)

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

**415**: The request body's Content-Type is missing or not supported. Send the body as application/json.
Response body (`application/json`, object):
- `error` (string, required)

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

**429**: Too many requests. The rate limit was exceeded.
Response body (`application/json`, object):
- `error` (string, required)

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

**500**: An unexpected server error occurred.
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.