Skip to main content

Update a sub number order

PATCH 

/sub_number_orders/:sub_number_order_id

Updates a sub number order.

Request

Path Parameters

    sub_number_order_id stringrequired

    The sub number order 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 sub number order.

Schema

    data

    SubNumberOrder

    id uuid
    order_request_id uuid
    country_code string
    phone_number_type string

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

    user_id uuid

    regulatory_requirements

    SubNumberOrderRegulatoryRequirement[]

  • Array [

  • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

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

  • ]

  • record_type string
    phone_numbers_count integer

    The count of phone numbers in the number order.

    created_at datetime

    An ISO 8901 datetime string denoting when the number order was created.

    updated_at datetime

    An ISO 8901 datetime string for when the number order was updated.

    requirements_met boolean

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

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...