Update a DIR reference

Partially update one reference, addressed by the DIR id plus the reference’s type (business or financial) and slot.

Cosmetic fields (full name, job title, organization, relationship, email) are always editable. The phone number and timezone may only be changed while a scheduled call has not yet been dialed; if a call is in progress or all attempts are complete, those fields are locked. Changing the timezone reschedules any pending call into the new local calling window.

PATCH

dir

{dir_id}

references

{ref_type}

{slot}

JavaScript

import Telnyx from 'telnyx';

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

const ReferenceWrapped = await client.dir.references.update('dir_id', 'ref_type', 'slot', {
  full_name: 'Dana Reyes',
});

console.log(ReferenceWrapped.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
reference_wrapped = client.dir.references.update(
    dir_id="dir_id",
    ref_type="ref_type",
    slot="slot",
    full_name="Dana Reyes",
)
print(reference_wrapped.data)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	reference, err := client.Dir.References.Update(
		context.TODO(),
		"dir_id",
		"ref_type",
		"slot",
		telnyx.DirReferenceUpdateParams{
			FullName: telnyx.String("Dana Reyes"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", reference.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.references.ReferenceUpdateParams;

public final class Main {
    private Main() {}

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

        ReferenceUpdateParams params = ReferenceUpdateParams.builder()
            .fullName("Dana Reyes")
            .build();
        var response = client.dir().references().update("dir_id", "ref_type", "slot", params);
    }
}

require "telnyx"

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

reference_wrapped = telnyx.dir.references.update(
  "dir_id",
  "ref_type",
  "slot",
  full_name: "Dana Reyes"
)

puts(reference_wrapped)

<?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 {
  $reference_wrapped = $client->dir->references->update(
    'dir_id',
    'ref_type',
    'slot',
    full_name: 'Dana Reyes',
  );

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

curl --request PATCH \
  --url https://api.telnyx.com/v2/dir/{dir_id}/references/{ref_type}/{slot} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "Dana Reyes",
  "job_title": "VP of Operations",
  "organization": "Acme Logistics",
  "relationship_to_registrant": "Supplier",
  "phone_e164": "+14155550123",
  "email": "dana.reyes@example.com",
  "timezone": "America/New_York"
}
'

{
  "data": {
    "record_type": "dir_reference",
    "ref_type": "business",
    "slot": 1,
    "full_name": "Dana Reyes",
    "phone_e164": "+14155550123",
    "timezone": "America/New_York",
    "job_title": "VP of Operations",
    "organization": "Acme Logistics",
    "relationship_to_registrant": "Supplier",
    "email": "dana.reyes@example.com"
  }
}

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"

ref_type

enum<string>

required

Reference type to address.

Available options:

business,

financial

Example:

"business"

slot

integer

required

Reference slot, counting from 1. Business references are slots 1 and 2, matching the order they were sent in the business_references array; the financial reference is slot 1. Every reference returned by the submit and list endpoints carries its own ref_type and slot, so you do not need to derive them.

Required range: 1 <= x <= 2

Example:

1

Body

application/json

Partial update for a single reference; supply at least one field. Cosmetic fields are always editable. phone_e164 and timezone may only be changed while a scheduled call has not yet been dialed.

full_name

string

The full name of the person we should contact as your reference.

Required string length: 1 - 255

Example:

"Dana Reyes"

job_title

string | null

The reference contact's job title, for example CFO or Owner.

Maximum string length: 255

Example:

"VP of Operations"

organization

string | null

The name of the organization the reference contact works for.

Maximum string length: 255

Example:

"Acme Logistics"

relationship_to_registrant

string | null

How the reference contact is related to the registering business.

Maximum string length: 255

Example:

"Supplier"

phone_e164

string

The reference's phone number in E.164 format, for example +14155550123. We call this number during their local business hours.

Pattern: ^\+[1-9]\d{1,14}$

Example:

"+14155550123"

string<email>

The reference's email address. We email them scheduling and dial-in instructions before we call, so use an address they check.

Example:

"dana.reyes@example.com"

timezone

string

The reference's IANA time zone, for example America/New_York. We only call during their local 8am to 9pm hours, which is why we need it.

Example:

"America/New_York"

Response

The updated reference.

data

object

required

A reference (business or financial) on a DIR, in the customer-facing shape. No internal identifiers are exposed.

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
});

const ReferenceWrapped = await client.dir.references.update('dir_id', 'ref_type', 'slot', {
  full_name: 'Dana Reyes',
});

console.log(ReferenceWrapped.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
reference_wrapped = client.dir.references.update(
    dir_id="dir_id",
    ref_type="ref_type",
    slot="slot",
    full_name="Dana Reyes",
)
print(reference_wrapped.data)

package main

import (
	"context"
	"fmt"

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

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	reference, err := client.Dir.References.Update(
		context.TODO(),
		"dir_id",
		"ref_type",
		"slot",
		telnyx.DirReferenceUpdateParams{
			FullName: telnyx.String("Dana Reyes"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", reference.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.references.ReferenceUpdateParams;

public final class Main {
    private Main() {}

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

        ReferenceUpdateParams params = ReferenceUpdateParams.builder()
            .fullName("Dana Reyes")
            .build();
        var response = client.dir().references().update("dir_id", "ref_type", "slot", params);
    }
}

require "telnyx"

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

reference_wrapped = telnyx.dir.references.update(
  "dir_id",
  "ref_type",
  "slot",
  full_name: "Dana Reyes"
)

puts(reference_wrapped)

<?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 {
  $reference_wrapped = $client->dir->references->update(
    'dir_id',
    'ref_type',
    'slot',
    full_name: 'Dana Reyes',
  );

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

curl --request PATCH \
  --url https://api.telnyx.com/v2/dir/{dir_id}/references/{ref_type}/{slot} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "Dana Reyes",
  "job_title": "VP of Operations",
  "organization": "Acme Logistics",
  "relationship_to_registrant": "Supplier",
  "phone_e164": "+14155550123",
  "email": "dana.reyes@example.com",
  "timezone": "America/New_York"
}
'

{
  "data": {
    "record_type": "dir_reference",
    "ref_type": "business",
    "slot": 1,
    "full_name": "Dana Reyes",
    "phone_e164": "+14155550123",
    "timezone": "America/New_York",
    "job_title": "VP of Operations",
    "organization": "Acme Logistics",
    "relationship_to_registrant": "Supplier",
    "email": "dana.reyes@example.com"
  }
}

Branded Calling

For AI Agents

Update a DIR reference

Authorizations

Path Parameters

Body

Response