Sign in
Verified Caller ID

Update verified caller ID

Changes the configurable label of an external verified caller-ID record by ID. Use it to maintain the record after verification; updating a project-owned phone number uses Update phone number instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

put/api/relay/rest/verified_caller_ids/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the verified caller ID.

Request body

namestring required

The name portion of the caller ID.

Example request

{
  "name": "C-3P0"
}

Response

The request has succeeded.

typestring

The type of the returned object, this should be verified_caller_id.

idstring uuid required

Universal Unique Identifier.

numberstring required

String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.

namestring

String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.

extensionstring

String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.

verifiedboolean required

A boolean representing whether the number has been verified or not.

verified_atstring date-time

Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.

status'Verified' | 'Awaiting Verification'

The verification status for the caller ID.

Example response

{
  "type": "verified_caller_id",
  "number": "+15551234567",
  "name": "C-3P0",
  "extension": "1234",
  "status": "Awaiting Verification"
}

Changes

No changes found, but 3 of the 138 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.