Skip to main content

Update a Verified Calls Display Profile

PATCH 

/verified_calls_display_profiles/:id

Update an existing Verified Calls Display Profile and allows adding/removing nested Call Reasons and Phone Numbers. Different attributes can be updated depending on the Verified Calls Display Profile's status: For the VERIFICATION_STATE_PENDING status, no fields can be updated. For the VERIFICATION_STATE_VERIFIED status, it is allowed only to add/remove Call Reaons and Phone Numbers. For the other statuses, all fields can be updated. All existing Call Reasons and Phone Numbers must be sent during the request, or the update will fail.

Request

Path Parameters

    id stringrequired

    Identifies the Verified Calls Display Profile

Body

required

    call_reasons

    object[]

  • Array [

  • reason string

    The Call Reason text to be displayed to the call recipient

    delete boolean

    Marks the Phone Number to be removed from the Display Profile

  • ]

  • phone_numbers

    object[]

  • Array [

  • phone_number e164

    The phone number in e164 format

    delete boolean

    Marks the Phone Number to be removed from the Display Profile

  • ]

Responses

200: Verified Calls 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...