Update a number order

Updates a phone number order.

curl --location --request PATCH '/number_orders/' \ --header 'Content-Type: application/json' \ --data-raw '{ "customer_reference": "MY REF 001", "regulatory_requirements": [ { "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" } ] }'

{ "data": { "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600", "connection_id": "346789098765567", "created_at": "2018-01-01T00:00:00.000000Z", "customer_reference": "MY REF 001", "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600", "phone_numbers": [ { "bundle_id": null, "country_code": "US", "deadline": "024-05-31T11:14:00+00:00", "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "is_block_number": false, "locality": "San Francisco", "order_request_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd495", "phone_number": "+19705555098", "phone_number_type": "local", "record_type": "number_order_phone_number", "regulatory_requirements": [ { "field_type": "textual", "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21", "record_type": "phone_number_regulatory_requirement", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" } ], "requirements_met": true, "requirements_status": "pending", "status": "pending", "sub_number_order_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd496" } ], "phone_numbers_count": 1, "record_type": "number_order", "requirements_met": true, "status": "pending", "sub_number_orders_ids": [ "string" ], "updated_at": "2018-01-01T00:00:00.000000Z" } }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

number_order_id

string

required

The number order ID.

Body Params application/json

customer_reference

string

optional

A customer reference string for customer look ups.

Example:

MY REF 001

regulatory_requirements

array[object (UpdateRegulatoryRequirement) {2}]

optional

field_value

string

optional

The value of the requirement. For address and document requirements, this should be the ID of the resource. For textual, this should be the value of the requirement.

Example:

45f45a04-b4be-4592-95b1-9306b9db2b21

requirement_id

string <uuid>

optional

Unique id for a requirement.

Example:

8ffb3622-7c6b-4ccc-b65f-7a3dc0099576

Examples

Responses

🟢200OK

application/json

Successful response with details about a number order.

Body

data

object (NumberOrder)

optional

billing_group_id

string

optional

Identifies the messaging profile associated with the phone number.

Example:

abc85f64-5717-4562-b3fc-2c9600

connection_id

string

optional

Identifies the connection associated with this phone number.

Example:

346789098765567

created_at

string <datetime>

read-onlyoptional

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

Example:

2018-01-01T00:00:00.000000Z

customer_reference

string

optional

A customer reference string for customer look ups.

Example:

MY REF 001

string <uuid>

read-onlyoptional

Example:

12ade33a-21c0-473b-b055-b3c836e1c292

messaging_profile_id

string

optional

Identifies the messaging profile associated with the phone number.

Example:

abc85f64-5717-4562-b3fc-2c9600

phone_numbers

array[object (NumberOrderPhoneNumber) {15}]

optional

phone_numbers_count

integer

read-onlyoptional

The count of phone numbers in the number order.

Example:

record_type

string

read-onlyoptional

Example:

number_order

requirements_met

boolean

read-onlyoptional

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

Example:

true

status

enum<string>

read-onlyoptional

The status of the order.

Allowed values:

pendingsuccessfailure

sub_number_orders_ids

array[string]

optional

updated_at

string <datetime>

read-onlyoptional

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

Example:

2018-01-01T00:00:00.000000Z

🔴500Server Error