> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inworld.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a PVC voice

> Updates editable metadata on a PVC voice. Editing a `PVC_VOICE_STATE_FAILED` voice returns it to `PVC_VOICE_STATE_DRAFT` and preserves its samples, so you can fix the issue and retrain. A voice that is queued, training, or ready cannot be updated. Retry after it finishes, or after re-editing brings a failed voice back to draft.

Currently, `displayName` is the only editable field. The `updateMask` query parameter is **required** and uses **snake_case** field paths (for example: `?updateMask=display_name`) — an empty or missing mask returns `400`.

<Note>
**Editing a failed voice.** [Add or remove samples](https://docs.inworld.ai/api-reference/pvcAPI/pvcvoiceservice/upload-pvc-voice-samples.md) and [retrain](https://docs.inworld.ai/api-reference/pvcAPI/pvcvoiceservice/train-pvc-voice.md) without re-uploading everything.
</Note>

<Warning>
Returns `409` while the voice is queued, training, or ready.
</Warning>

## API reference

**Endpoint:** `PATCH https://api.inworld.ai/voices/v1/pvcVoices/{voiceId}`

### Authorization

- `Authorization` (string; required) — Your [API key](../../../api-reference/introduction). Read permissions are required for GET endpoints. Write permissions are required for POST, PATCH, and DELETE endpoints.
  
   For Basic authentication, please populate `Basic $INWORLD_API_KEY`. You can create a key in one command with the [Inworld CLI](../../../developer-tools/inworld-cli): `inworld workspace add-key`.

### Path parameters

- `voiceId` (string; required) — Voice ID of the PVC voice to update.

### Query parameters

- `updateMask` (string; required) — Comma-separated list of fields to update. Required. An empty or missing mask returns `400`. Fields present in the body but omitted from the mask are ignored.
  
  Mask paths use **snake_case** field names, even though the request body uses camelCase. Supported paths: `display_name`.

### Request body

Content type: `application/json`

- `displayName` (string) — The voice's new display name. Include `display_name` (snake_case) in `updateMask` to apply this field.

#### Request example

```json
{
  "displayName": "renamed-professional-voice"
}
```

### Response

Status: `200`. Content type: `application/json`.

- `name` (string) — Resource name. Format: `workspaces/{workspace}/pvcVoices/{voice}`.
- `voiceId` (string) — Voice ID, derived from `displayName` at creation time. Use this value as `{voiceId}` on every other PVC endpoint, and as the `voiceId` in TTS synthesis requests once the voice is `PVC_VOICE_STATE_READY`.
- `displayName` (string) — The human-readable name shown anywhere the voice is listed or selected.
- `languageCode` (string) — The voice's language as a BCP-47-shaped locale string, e.g. `en-US`. Immutable after creation.
- `state` (enum<string>; options: "PVC_VOICE_STATE_UNSPECIFIED", "PVC_VOICE_STATE_DRAFT", "PVC_VOICE_STATE_QUEUED", "PVC_VOICE_STATE_TRAINING", "PVC_VOICE_STATE_READY", "PVC_VOICE_STATE_FAILED") — Lifecycle state of a PVC voice.
  
  - `PVC_VOICE_STATE_DRAFT`: Editable. Samples can be added, trimmed, or removed, and metadata can be updated.
  - `PVC_VOICE_STATE_QUEUED`: Training requested; waiting for a training slot.
  - `PVC_VOICE_STATE_TRAINING`: Actively training.
  - `PVC_VOICE_STATE_READY`: Training succeeded. Usable for TTS synthesis. It's permanent and cannot be deleted through this API.
  - `PVC_VOICE_STATE_FAILED`: Training failed. Editing the voice (e.g. renaming it, or adding/removing a sample) returns it to `PVC_VOICE_STATE_DRAFT` with its remaining samples intact.
- `failure` (object) — Populated on a PVC voice when its `state` is `PVC_VOICE_STATE_FAILED`.
  - `reason` (string) — Machine-readable failure code, e.g. `TRAINING_ERROR`. New values may be added over time, so don't validate against a hardcoded list. Fall back to displaying `message` for codes you don't recognize.
  - `message` (string) — Human-readable, scrubbed failure message. Never contains uploaded audio, filenames, or transcripts.
- `incarnationId` (string) — Identifier that stays stable across edits to the same voice, and changes each time it is retrained. Use it to tell two reads of the same `voiceId` apart across a retrain.
- `samples` (object[]) — Audio samples currently attached to the voice.
  - `sampleId` (string) — Sample ID. Use this value as `{sampleId}` when trimming or deleting the sample.
  - `name` (string) — Resource name. Format: `workspaces/{workspace}/pvcVoices/{voice}/samples/{sample}`.
  - `sizeBytes` (integer) — Size of the uploaded file, in bytes.
  - `durationSecs` (number) — Analyzed duration of the sample, in seconds, before any trim is applied.
  - `mimeType` (enum<string>; options: "audio/wav", "audio/webm", "audio/mpeg") — Detected audio format, sniffed from the file's byte content.
  - `hash` (string) — Base64-encoded MD5 of the stored object, for verifying upload integrity against the source file.
  - `trimStartMs` (integer) — Trim start offset in milliseconds, if set.
  - `trimEndMs` (integer) — Trim end offset in milliseconds, if set.
- `createTime` (string)
- `updateTime` (string)

### Response examples

#### 200: default_response

```json
{
  "name": "string",
  "voiceId": "string",
  "displayName": "string",
  "languageCode": "string",
  "state": "PVC_VOICE_STATE_UNSPECIFIED",
  "failure": {
    "reason": "string",
    "message": "string"
  },
  "incarnationId": "string",
  "samples": [
    {
      "sampleId": "string",
      "name": "string",
      "sizeBytes": 0,
      "durationSecs": 0,
      "mimeType": "audio/wav",
      "hash": "string",
      "trimStartMs": 0,
      "trimEndMs": 0
    }
  ],
  "createTime": "string",
  "updateTime": "string"
}
```

#### 400: empty_mask

```json
{
  "code": 3,
  "message": "invalid request: updateMask must not be empty",
  "details": []
}
```

#### 409: frozen

```json
{
  "code": 9,
  "message": "pvc voice 'my-professional-voice' cannot be modified while in state PVC_VOICE_STATE_TRAINING",
  "details": []
}
```

#### default: default_response

```json
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
```

### Code examples

#### cURL

```bash
curl --location --request PATCH 'https://api.inworld.ai/voices/v1/pvcVoices/<voice-id>?updateMask=display_name' \
--header "Authorization: Basic $INWORLD_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "renamed-professional-voice"
}'
```

#### Python

```python
import requests

voice_id = "<voice-id>"
url = f"https://api.inworld.ai/voices/v1/pvcVoices/{voice_id}"
headers = {
    "Authorization": "Basic <api-key>",
    "Content-Type": "application/json"
}
params = {"updateMask": "display_name"}
payload = {"displayName": "renamed-professional-voice"}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())
```

#### JavaScript

```javascript
const voiceId = '<voice-id>';
const url = `https://api.inworld.ai/voices/v1/pvcVoices/${voiceId}?updateMask=display_name`;

const response = await fetch(url, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Basic <api-key>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ displayName: 'renamed-professional-voice' }),
});

const data = await response.json();
console.log(data);
```