Skip to main content

Deletes the Verified Calls Display Profile

DELETE 

/verified_calls_display_profiles/:id

Deletes the Verified Calls Display Profile. This action will fail if any verification requests have been made for this Verified Calls Display Profile. Please contact [email protected] in case you want to delete a Verified Calls Display Profile in that situation.

Request

Path Parameters

    id stringrequired

    Identifies the Verified Calls Display Profile

Responses

200: Successful response with a Verified Calls Display Profile.

Schema

    data

    object

    record_type string
    id uuid
    name string

    The Verified Calls Display Profile's name

    display_name string

    The display name to be shown as the caller name in phones

    logo_url string

    The URL pointing to a public image file that will be displayed during calls in phones

    status string

    Possible values: [VERIFICATION_STATE_UNSPECIFIED, VERIFICATION_STATE_UNVERIFIED, VERIFICATION_STATE_PENDING, VERIFICATION_STATE_VERIFIED, VERIFICATION_STATE_SUSPENDED_IN_GMB]

    The approval status of the Verified Calls Display Profile in Google

    business_identity

    object

    The associated Business Identity

    record_type string
    name string

    The name of the business identity on the telnyx platform

    phone_numbers

    object[]

  • Array [

  • record_type string
    id uuid
    phone_number e164

    The phone number in e164 format

    google_verification_status string

    Possible values: [STATE_UNSPECIFIED, PENDING_APPROVAL, APPROVED, DENIED, PENDING_REMOVAL]

    The approval status of this individual phone number in Google

    google_approval_info string

    Additional information about the decision, if available.

    display_profile_id uuid
    delete boolean

    Marks the Phone Number to be removed from the Display Profile

  • ]

  • call_reasons

    object[]

  • Array [

  • record_type string
    id uuid
    reason string

    The Call Reason text to be displayed to the call recipient

    google_verification_status string

    Possible values: [STATE_UNSPECIFIED, PENDING_APPROVAL, APPROVED, DENIED, PENDING_REMOVAL]

    The approval status of this individual call reason in Google

    google_approval_info string

    Additional information about the decision, if available.

    display_profile_id uuid
    delete boolean

    Marks the Phone Number to be removed from the Display Profile

  • ]

  • created_at datetime

    An ISO 8601 datetime string for when the display profile was added to the Telnyx platform

    updated_at datetime

    An ISO 8601 datetime string for when the display profile was updated

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Loading...