--- title: Create Custom Voice Phrase (deprecated) description: Use the POST {{apiPath}}/v1/environments/{{envID}}/voicePhrases request to create a verify voice phrase in the environment. component: pingone-api page_id: pingone-api:verify:verify-voice-phrases/create-custom-voice-phrase canonical_url: https://developer.pingidentity.com/pingone-api/verify/verify-voice-phrases/create-custom-voice-phrase.html section_ids: headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Create Custom Voice Phrase (deprecated) ## ```none POST {{apiPath}}/v1/environments/{{envID}}/voicePhrases ``` Use the `POST {{apiPath}}/v1/environments/{{envID}}/voicePhrases` request to create a verify voice phrase in the environment. | | | | - | -------------------------------------------------------------------------- | | | Voice verification is deprecated and will be removed on November 25, 2026. | > **Collapse: Request Model** > > | Property | Type | Required? | > | ------------- | ------ | --------- | > | `displayName` | String | Required | > > Note that `displayName` must be unique within the environment identified by `{{envID}}`. This request creates only a named container for the voice phrase contents. Use [Create Custom Voice Phrase Content (deprecated)](create-custom-voice-phrase-content.html) to add a phrase to speak in a specific language. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "displayName": "Brilliant journeys" } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/voicePhrases' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "displayName": "Brilliant journeys" }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/voicePhrases") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""displayName"": ""Brilliant journeys""" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/voicePhrases" method := "POST" payload := strings.NewReader(`{ "displayName": "Brilliant journeys" }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /v1/environments/{{envID}}/voicePhrases HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "displayName": "Brilliant journeys" } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"displayName\": \"Brilliant journeys\"\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/voicePhrases") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/voicePhrases", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "displayName": "Brilliant journeys" }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/voicePhrases', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "displayName": "Brilliant journeys" }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/voicePhrases" payload = json.dumps({ "displayName": "Brilliant journeys" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/voicePhrases'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer {{accessToken}}' )); $request->setBody('{\n "displayName": "Brilliant journeys"\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/voicePhrases") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "displayName": "Brilliant journeys" }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"displayName\": \"Brilliant journeys\"\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/voicePhrases")!,timeoutInterval: Double.infinity) request.addValue("application/json", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "POST" request.httpBody = postData let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 201 Created ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/voicePhrases/ff5c9066-db46-4c06-92dc-dfd19ab28f52" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" } }, "id": "ff5c9066-db46-4c06-92dc-dfd19ab28f52", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "displayName": "Brilliant journeys", "createdAt": "2022-08-24T15:51:39.095Z", "updatedAt": "2022-08-24T15:51:39.095Z" } ```