Update a verified number

PATCH

/v1/voice/verified-numbers/{verified_number_id}

const verifiedNumber = await bird.voice.verifiedNumbers.update("vvn_01krdgeqcxet5s7t44vh8rt9mg", { name: "Sales line" });
console.log(verifiedNumber.name);

verified_number = client.voice.verified_numbers.update("vvn_01krdgeqcxet5s7t44vh8rt9mg", name="Sales line")
print(verified_number.name)

verifiedNumber, err := client.Voice.VerifiedNumbers.Update(context.Background(), "vvn_01krdgeqcxet5s7t44vh8rt9mg", bird.VoiceVerifiedNumbersUpdateParams{
	Name: bird.Value("Sales line"),
})
if err != nil {
	log.Fatal(err)
}
if verifiedNumber.Name != nil {
	fmt.Println(*verifiedNumber.Name)
}

$verifiedNumber = $bird->voice->verifiedNumbers->update(
    'vvn_01krdgeqcxet5s7t44vh8rt9mg', (new VoiceVerifiedNumberUpdate())->setName('Sales line'),
);
echo $verifiedNumber->getName(), "\n";

bird voice verified-numbers update <verified-number-id> \
  --name 'Support line'

curl -X PATCH "https://us1.platform.bird.com/v1/voice/verified-numbers/{verified_number_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support line"
  }'

Respons200

{
  "id": "vvn_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "name": "Support line",
  "status": "pending",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Updates the verified number's label. Omitted fields stay unchanged, and sending name as null clears the label. The number itself cannot be changed: register the number you want and verify it separately. Renaming leaves the verification state untouched, so a verified number stays usable and a pending one keeps the code it is waiting for.

Parameter

verified_number_id

string

Payload Permintaan

name

nullable string

Your new label for this verified number. Send null to clear it and go back to identifying the verified number by its number alone. It is yours to choose and appears nowhere on a call, so renaming never affects what the person you are calling sees, and it leaves the number and its verification untouched.

Payload Respons

string

wajib

Unique identifier for this verified number.

workspace_id

string

wajib

phone_number

string

wajib

The phone number in E.164 format registered as an outbound caller ID.

name

nullable string

wajib

Your label for this verified number, to tell several registered numbers apart. null when the verified number has no label. It is yours to choose and appears nowhere on a call, so changing it never affects what the person you are calling sees. Set it with the verified number update operation.

status

string

wajib

Verification state of the verified number.

pending: the number is registered but ownership has not yet been proven.
verified: the workspace proved ownership of the number. Check the resource's activation or direction fields for outbound availability.
failed: terminal because the verification challenge expired or the attempt limit was exhausted. Delete the verified number and register it again to retry.

Open enum: additional states may be added over time, so treat an unrecognized value as a future state rather than an error.

Possible values (may grow over time): pending, verified, failed

outbound_enabled

boolean

wajib

Whether outbound caller ID activation has completed. A verified number can remain inactive until activation requirements are met. Outbound calls remain subject to routing and number ownership requirements.

verified_at

nullable string

wajib

When the verified number was verified. null when its status is pending or failed.

created_at

string

wajib

updated_at

string

wajib

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Should I use a Bird SDK or call the API directly?Pahami konsepnya

Build your first integrationIkuti jalur pembelajaran

Send your first emailPanduan implementasi

Dapatkan ringkasan implementasi

const verifiedNumber = await bird.voice.verifiedNumbers.update("vvn_01krdgeqcxet5s7t44vh8rt9mg", { name: "Sales line" });
console.log(verifiedNumber.name);

verified_number = client.voice.verified_numbers.update("vvn_01krdgeqcxet5s7t44vh8rt9mg", name="Sales line")
print(verified_number.name)

verifiedNumber, err := client.Voice.VerifiedNumbers.Update(context.Background(), "vvn_01krdgeqcxet5s7t44vh8rt9mg", bird.VoiceVerifiedNumbersUpdateParams{
	Name: bird.Value("Sales line"),
})
if err != nil {
	log.Fatal(err)
}
if verifiedNumber.Name != nil {
	fmt.Println(*verifiedNumber.Name)
}

$verifiedNumber = $bird->voice->verifiedNumbers->update(
    'vvn_01krdgeqcxet5s7t44vh8rt9mg', (new VoiceVerifiedNumberUpdate())->setName('Sales line'),
);
echo $verifiedNumber->getName(), "\n";

bird voice verified-numbers update <verified-number-id> \
  --name 'Support line'

curl -X PATCH "https://us1.platform.bird.com/v1/voice/verified-numbers/{verified_number_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support line"
  }'

Respons200

{
  "id": "vvn_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "name": "Support line",
  "status": "pending",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}