Request deletion of a DIR

Request deletion of a DIR. This does not remove the DIR on this call: it records the request, moves the DIR to delete_requested, and Telnyx completes the removal (de-registration and cleanup) shortly after. A verified DIR keeps serving its branded identity, and keeps billing, until the removal is executed. Failure modes: 400 if a child phone number is still attached or the DIR is in_review (wait for the review to finish), 409 if the DIR has an unresolved infringement claim, 404 if the DIR is not yours.

DELETE

dir

{dir_id}

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.dir.delete('16635d38-75a6-4481-82e8-69af60e05011');

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.dir.delete(
    "16635d38-75a6-4481-82e8-69af60e05011",
)

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.Dir.Delete(context.TODO(), "16635d38-75a6-4481-82e8-69af60e05011")
	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.dir.DirDeleteParams;

public final class Main {
    private Main() {}

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

        client.dir().delete("16635d38-75a6-4481-82e8-69af60e05011");
    }
}

<?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->dir->delete('16635d38-75a6-4481-82e8-69af60e05011');

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

{
  "data": {
    "id": "16635d38-75a6-4481-82e8-69af60e05011",
    "status": "delete_requested"
  }
}

Authorizations

Authorization

string

header

required

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

Path Parameters

dir_id

string<uuid>

required

The DIR id. Lowercase UUID.

Example:

"16635d38-75a6-4481-82e8-69af60e05011"

Response

Deletion requested. The DIR moves to delete_requested and is torn down shortly after.

data

object

required

Show child attributes

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.dir.delete('16635d38-75a6-4481-82e8-69af60e05011');

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.dir.delete(
    "16635d38-75a6-4481-82e8-69af60e05011",
)

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.Dir.Delete(context.TODO(), "16635d38-75a6-4481-82e8-69af60e05011")
	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.dir.DirDeleteParams;

public final class Main {
    private Main() {}

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

        client.dir().delete("16635d38-75a6-4481-82e8-69af60e05011");
    }
}

<?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->dir->delete('16635d38-75a6-4481-82e8-69af60e05011');

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

{
  "data": {
    "id": "16635d38-75a6-4481-82e8-69af60e05011",
    "status": "delete_requested"
  }
}

Branded Calling

For AI Agents

Request deletion of a DIR

Authorizations

Path Parameters

Response