---
title: "Rename or describe a group value"
method: PATCH
path: "/groups/values"
tags: ["Groups"]
---

# Rename or describe a group value

`PATCH /groups/values`

## Request

- Base URL: `https://api.textla.com/v1`
- URL: `https://api.textla.com/v1/groups/values`
- Auth: HTTP bearer

Renames a group value account-wide and/or updates its description. At least one of new_value or description must be supplied; otherwise the API returns 400. old_value is matched case-insensitively. When a rename targets an existing value, the surviving value keeps its casing and description unless description is supplied. A missing old_value is normally a tolerant no-op; when both new_value and description are supplied, description still applies to the destination. The required action_audit object records who and what initiated the change.

## Request body

- union
  - object
    - `$schema` string, uri: A URL to the JSON Schema for this object.
    - `action_audit` ValueActionAudit, required
      - `actor` string, required: User, API client, or system identifier that triggered the action
      - `reason` string: Optional explanation for the action
      - `source` string, required: Interface or system that initiated the action
    - `description` string: Optional description; an empty string clears it
    - `new_value` string, required: Optional account-wide replacement value
    - `old_value` string, required: Existing value to patch
  - object
    - `$schema` string, uri: A URL to the JSON Schema for this object.
    - `action_audit` ValueActionAudit, required
      - `actor` string, required: User, API client, or system identifier that triggered the action
      - `reason` string: Optional explanation for the action
      - `source` string, required: Interface or system that initiated the action
    - `description` string, required: Optional description; an empty string clears it
    - `new_value` string: Optional account-wide replacement value
    - `old_value` string, required: Existing value to patch

## Response `200`

OK

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `412`: Precondition Failed
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `502`: Bad Gateway
- `503`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/textla/apis/textla-api.md) - [All operations](https://skmtc.dev/textla/apis/textla-api/llms.txt) - [OpenAPI document](https://skmtc.dev/textla/apis/textla-api/revisions/473f03350bc1?raw)