Skip to main content

Update a number order phone number.

PATCH 

/number_order_phone_numbers/:number_order_phone_number_id

Updates a number order phone number.

Request

Path Parameters

    number_order_phone_number_id stringrequired

    The number order phone number ID.

Body

required

    regulatory_requirements

    UpdateRegulatoryRequirement[]

  • Array [

  • requirement_id uuid

    Unique id for a requirement.

    field_value string

    The value of the requirement, this could be an id to a resource or a string value.

  • ]

Responses

200: Successful response with details about a number order phone number.

Schema

    data

    NumberOrderPhoneNumber

    id uuid
    record_type string
    phone_number e164_phone_number
    order_request_id uuid
    sub_number_order_id uuid
    country_code string
    phone_number_type string

    Possible values: [local, toll_free, mobile, national, shared_cost, landline]

    regulatory_requirements

    SubNumberOrderRegulatoryRequirementWithValue[]

  • Array [

  • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

    Possible values: [textual, datetime, address, document]

    field_value string

    The value of the requirement, this could be an id to a resource or a string value.

  • ]

  • requirements_met boolean

    True if all requirements are met for a phone number, false otherwise.

    status string

    Possible values: [pending, success, failure]

    The status of the phone number in the order.

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 query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Loading...