Delete a voice design

Permanently deletes a voice design and all of its versions. This action cannot be undone.

DELETE /voice_designs/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.voiceDesigns.delete('id');

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
client.voice_designs.delete(
    "id",
)

package main

import (
	"context"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	err := client.VoiceDesigns.Delete(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.voicedesigns.VoiceDesignDeleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        client.voiceDesigns().delete("id");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

result = telnyx.voice_designs.delete("id")

puts(result)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $result = $client->voiceDesigns->delete('id');

  var_dump($result);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx voice-designs delete \
  --api-key 'My API Key' \
  --id id

curl --request DELETE \
  --url https://api.telnyx.com/v2/voice_designs/{id} \
  --header 'Authorization: Bearer <token>'

401

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The voice design UUID or name.

Response

204

Voice design deleted successfully.