---
title: "Update voice by ID"
method: PATCH
path: "/v1/tones/{toneId}"
tags: ["Voices"]
---

# Update voice by ID

`PATCH /v1/tones/{toneId}`

Update an existing voice by ID

## Path parameters

- `toneId` string, required

## Request body

- UpdateToneDto
  - `name` string — The friendly name of the voice.
  - `value` string — The voices's description.
  - `metadata` object — An optional set of key-value pairs to attach any data you wish to the voice, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long.
  - `settings` ToneSettingsDto
    - `appVisibility` 'visible' | 'hidden' — Whether the brand is available in the Jasper app. Provides a way to omit voices created from the API, from being available in the Jasper app experience. One of "visible" or "hidden". Defaults to "visible".

## Response `200`

Update an existing voice

- GetToneResponseDto
  - `requestId` string
  - `resource` string
  - `data` ToneDto
    - `name` string, required — The friendly name of the voice.
    - `value` string, required — The voice's description
    - `metadata` object — An optional set of key-value pairs to attach any data you wish to the voice, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long.
    - `settings` ToneSettingsDto
      - `appVisibility` 'visible' | 'hidden' — Whether the brand is available in the Jasper app. Provides a way to omit voices created from the API, from being available in the Jasper app experience. One of "visible" or "hidden". Defaults to "visible".
    - `id` string
    - `createdAt` string
    - `updatedAt` string

## Other responses

- `404` — Not found. May have an incorrect URL path or voice ID.
- `500` — Internal server error. Unable to update specified voice.

---

[API](https://skmtc.net/jasper/apis/jasper-api.md) · [All operations](https://skmtc.net/jasper/apis/jasper-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jasper/jasper-api/revisions/438914d9525e/schema)